mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-27 19:38:37 +01:00
Previously, all `m.room.*` events were wodged into `{{room_events}}` which
isn't great when you want to pull specific ones out. Batesian had a 1:1
mapping of `render_foo()` to a section `{{foo}}`, and having to constantly
add functions for new types is a PITA. Batesian now supports returning a
`dict` instead of a section `string` where the keys are the `{{foo}}` and
the value is what will be inserted. Also add conflicting section key checks
to avoid multiple definitions of the same `{{foo}}`. Define dicts for
event schemata and swagger HTTP APIs.
Using this new feature, split out the instant messaging stuff from the events
section, and replace `{{room_events}}` with a list of specific events e.g.
`{{m_room_member_event}}`.
40 lines
1.4 KiB
YAML
40 lines
1.4 KiB
YAML
targets:
|
|
main: # arbitrary name to identify this build target
|
|
files: # the sort order of files to cat
|
|
- 0-intro.rst
|
|
- { 1: 0-feature_profiles.rst }
|
|
- 1-client_server_api.rst
|
|
- { 1: 0-events.rst }
|
|
- { 1: 0-event_signing.rst }
|
|
- 2-modules.rst
|
|
- { 1: "group:modules" } # reference a group of files
|
|
- 3-application_service_api.rst
|
|
- 4-server_server_api.rst
|
|
- 5-identity_servers.rst
|
|
- 6-appendices.rst
|
|
groups: # reusable blobs of files when prefixed with 'group:'
|
|
modules:
|
|
- modules/instant_messaging.rst
|
|
- modules/voip_events.rst
|
|
- modules/typing_notifications.rst
|
|
- modules/receipts.rst
|
|
- modules/presence.rst
|
|
- modules/content_repo.rst
|
|
- modules/end_to_end_encryption.rst
|
|
- modules/history_visibility.rst
|
|
- modules/push_overview.rst
|
|
- { 2: [modules/push_cs_api.rst , modules/push_push_gw_api.rst] }
|
|
|
|
title_styles: ["=", "-", "~", "+", "^"]
|
|
|
|
# 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: ">"
|