matrix-spec/specification/targets.yaml

targets:
  main:
    files:
      - 00_00_intro.rst
      - 00_01_feature_profiles.rst
      - 00_02a_events.rst
      - 00_02b_event_signing.rst
      - 01_00_client_server_api.rst
      - 02_00_modules.rst
      - "group:module"
      - 03_00_application_service_api.rst
      - 04_00_server_server_api.rst
      - 05_00_identity_servers.rst
      - 06_00_appendices.rst
groups:
  modules:
    - modules/01_00_voip_events.rst
    - modules/02_00_typing_notifications.rst
    - modules/03_00_receipts.rst
    - modules/04_00_content_repo.rst
    - modules/05_00_end_to_end_encryption.rst
    - modules/06_00_history_visibility.rst
    - 1: modules/07_00_push_overview.rst
      2: [modules/07_01_push_cs_api.rst , modules/07_02_push_push_gw_api.rst]
title_styles:
 - "="
 - "-"
 - "~"
 - "+"
Add a 'targets.yaml' files in /specification We're well beyond the point now where a simple `cat` of .rst files to "build" the spec is practical. We may want to slice and dice the spec in different ways to address various cross-cutting concerns. To this end, there is now a 'targets' file which contains the "build targets" for the spec, which contains the sorting order for the .rst files. For now, we just have a single target: 'main'. 2015-09-21 15:31:57 +02:00			`targets:`
			`main:`
			`files:`
			`- 00_00_intro.rst`
			`- 00_01_feature_profiles.rst`
			`- 00_02a_events.rst`
			`- 00_02b_event_signing.rst`
			`- 01_00_client_server_api.rst`
			`- 02_00_modules.rst`
			`- "group:module"`
			`- 03_00_application_service_api.rst`
			`- 04_00_server_server_api.rst`
			`- 05_00_identity_servers.rst`
			`- 06_00_appendices.rst`
			`groups:`
			`modules:`
			`- modules/01_00_voip_events.rst`
			`- modules/02_00_typing_notifications.rst`
			`- modules/03_00_receipts.rst`
			`- modules/04_00_content_repo.rst`
			`- modules/05_00_end_to_end_encryption.rst`
			`- modules/06_00_history_visibility.rst`
Represent nested deps in targets.yaml along with title styles This will allow us to programatically position .rst snippets anywhere which will for once and for all remove the horrid title level mismatch bugs. We require this in order to allow people to re-shuffle the spec without having to adjust the spec itself (e.g. 2 targets with different levels of nesting). 2015-09-21 15:49:54 +02:00			`- 1: modules/07_00_push_overview.rst`
			`2: [modules/07_01_push_cs_api.rst , modules/07_02_push_push_gw_api.rst]`
			`title_styles:`
			`- "="`
			`- "-"`
			`- "~"`
			`- "+"`