2015-09-21 13:31:57 +00:00
|
|
|
targets:
|
2015-11-27 14:21:32 +00:00
|
|
|
index:
|
2015-12-09 16:17:58 +00:00
|
|
|
files:
|
|
|
|
- index.rst
|
2015-11-27 14:21:32 +00:00
|
|
|
client_server:
|
|
|
|
files:
|
2015-10-15 12:40:05 +00:00
|
|
|
- client_server_api.rst
|
|
|
|
- { 1: events.rst }
|
2015-11-30 14:31:24 +00:00
|
|
|
- { 1: modules.rst }
|
|
|
|
- { 2: feature_profiles.rst }
|
|
|
|
- { 2: "group:modules" } # reference a group of files
|
2016-05-05 17:26:17 +00:00
|
|
|
version_label: "%CLIENT_RELEASE_LABEL%"
|
2015-11-27 14:21:32 +00:00
|
|
|
application_service:
|
|
|
|
files:
|
2015-10-15 12:40:05 +00:00
|
|
|
- application_service_api.rst
|
2018-08-24 17:36:04 +00:00
|
|
|
version_label: "%APPSERVICE_RELEASE_LABEL%"
|
2015-11-27 14:21:32 +00:00
|
|
|
server_server:
|
|
|
|
files:
|
2015-10-15 12:40:05 +00:00
|
|
|
- server_server_api.rst
|
2016-05-05 17:26:17 +00:00
|
|
|
version_label: "%SERVER_RELEASE_LABEL%"
|
2018-08-31 21:35:32 +00:00
|
|
|
identity_service:
|
2016-03-09 15:49:23 +00:00
|
|
|
files:
|
2018-08-31 21:35:32 +00:00
|
|
|
- identity_service_api.rst
|
2018-08-31 21:03:48 +00:00
|
|
|
version_label: "%IDENTITY_RELEASE_LABEL%"
|
2016-04-06 17:28:21 +00:00
|
|
|
push_gateway:
|
|
|
|
files:
|
|
|
|
- push_gateway.rst
|
2018-08-16 17:44:48 +00:00
|
|
|
version_label: "%PUSH_GATEWAY_RELEASE_LABEL%"
|
2015-11-27 14:21:32 +00:00
|
|
|
appendices:
|
|
|
|
files:
|
2015-10-15 12:40:05 +00:00
|
|
|
- appendices.rst
|
2017-03-01 08:50:07 +00:00
|
|
|
- appendices/base64.rst
|
2016-10-31 12:36:47 +00:00
|
|
|
- appendices/signing_json.rst
|
2017-10-22 23:43:01 +00:00
|
|
|
- appendices/identifier_grammar.rst
|
2017-11-14 15:07:22 +00:00
|
|
|
- appendices/threepids.rst
|
2016-10-31 12:01:37 +00:00
|
|
|
- appendices/threat_model.rst
|
|
|
|
- appendices/test_vectors.rst
|
2018-05-02 12:47:01 +00:00
|
|
|
proposals:
|
|
|
|
files:
|
|
|
|
- proposals_intro.rst
|
|
|
|
- proposals.rst
|
2015-09-21 14:33:28 +00:00
|
|
|
groups: # reusable blobs of files when prefixed with 'group:'
|
2015-09-21 13:31:57 +00:00
|
|
|
modules:
|
2015-09-23 09:48:49 +00:00
|
|
|
- modules/instant_messaging.rst
|
2015-09-22 13:01:55 +00:00
|
|
|
- modules/voip_events.rst
|
|
|
|
- modules/typing_notifications.rst
|
|
|
|
- modules/receipts.rst
|
2018-08-30 22:21:31 +00:00
|
|
|
- modules/read_markers.rst
|
2015-09-23 08:59:54 +00:00
|
|
|
- modules/presence.rst
|
2015-09-22 13:01:55 +00:00
|
|
|
- modules/content_repo.rst
|
2016-09-29 12:18:45 +00:00
|
|
|
- modules/send_to_device.rst
|
2016-10-04 10:53:39 +00:00
|
|
|
- modules/device_management.rst
|
2015-09-22 13:01:55 +00:00
|
|
|
- modules/end_to_end_encryption.rst
|
|
|
|
- modules/history_visibility.rst
|
2015-10-07 13:00:16 +00:00
|
|
|
- modules/push.rst
|
2015-10-02 03:19:11 +00:00
|
|
|
- modules/third_party_invites.rst
|
2015-10-14 15:21:12 +00:00
|
|
|
- modules/search.rst
|
2015-11-06 18:15:21 +00:00
|
|
|
- modules/guest_access.rst
|
2016-02-19 15:26:28 +00:00
|
|
|
- modules/room_previews.rst
|
2015-10-26 16:22:04 +00:00
|
|
|
- modules/tags.rst
|
2015-11-19 10:36:27 +00:00
|
|
|
- modules/account_data.rst
|
2015-12-03 16:26:45 +00:00
|
|
|
- modules/admin.rst
|
2015-12-07 16:56:03 +00:00
|
|
|
- modules/event_context.rst
|
2016-08-08 16:33:48 +00:00
|
|
|
- modules/cas_login.rst
|
2016-10-03 17:17:43 +00:00
|
|
|
- modules/dm.rst
|
2018-03-06 16:00:32 +00:00
|
|
|
- modules/ignore_users.rst
|
2018-03-27 09:00:41 +00:00
|
|
|
- modules/stickers.rst
|
2018-05-27 18:19:30 +00:00
|
|
|
- modules/report_content.rst
|
2018-07-12 15:52:31 +00:00
|
|
|
- modules/third_party_networks.rst
|
2018-08-08 02:57:00 +00:00
|
|
|
- modules/openid.rst
|
2018-08-22 18:48:37 +00:00
|
|
|
- modules/server_acls.rst
|
2018-08-22 01:27:48 +00:00
|
|
|
- modules/mentions.rst
|
2015-09-22 12:08:15 +00:00
|
|
|
|
2015-10-14 15:26:14 +00:00
|
|
|
|
2016-02-15 16:50:15 +00:00
|
|
|
title_styles: ["=", "-", "~", "+", "^", "`", "@", ":"]
|
2015-09-22 12:08:15 +00:00
|
|
|
|
|
|
|
# The templating system doesn't know the right title style to use when generating
|
|
|
|
# RST. These symbols are 'relative' to say "make a sub-title" (-1), "make a title
|
|
|
|
# at the same level (0)", or "make a title one above (+1)". The gendoc script
|
|
|
|
# will inspect this file and replace these relative styles with actual title
|
|
|
|
# styles. The templating system will also inspect this file to know which symbols
|
|
|
|
# to inject.
|
|
|
|
relative_title_styles:
|
|
|
|
subtitle: "<"
|
|
|
|
sametitle: "/"
|
|
|
|
supertitle: ">"
|