Split spec into page-per-section

This commit is contained in:
Daniel Wagner-Hall 2015-11-27 14:21:32 +00:00
parent e961390f44
commit e171acf01f
4 changed files with 57 additions and 22 deletions

View file

@ -8,6 +8,16 @@ https://github.com/matrix-org/matrix-doc using
https://github.com/matrix-org/matrix-doc/blob/master/scripts/gendoc.py as of
revision ``{{git_version}}`` - https://github.com/matrix-org/matrix-doc/tree/{{git_rev}}
APIs
~~~~
The following APIs are documented in this specification:
- `Client-Server API <client_server.html>`_ for writing Matrix clients.
- `Server-Server API <server_server.html>`_ for writing servers which can federate with Matrix.
- `Application Service API <application_service.html>`_ for writing privileged plugins to servers.
There are also some `appendices <appendices.html>`_.
Changelog
~~~~~~~~~
{{spec_changelog}}

View file

@ -5,10 +5,8 @@ Typing Notifications
Users may wish to be informed when another user is typing in a room. This can be
achieved using typing notifications. These are ephemeral events scoped to a
``room_id``. This means they do not form part of the `Event Graph`_ but still
have a ``room_id`` key.
.. _Event Graph: `sect:event-graph`_
``room_id``. This means they do not form part of the
`Event Graph <index.html#event-graphs>`_ but still have a ``room_id`` key.
Events
------

View file

@ -1,16 +1,23 @@
targets:
main: # arbitrary name to identify this build target
index:
files: # the sort order of files to cat
- intro.rst
client_server:
files:
- client_server_api.rst
- { 1: events.rst }
- { 1: event_signing.rst }
- modules.rst
- { 1: feature_profiles.rst }
- { 1: "group:modules" } # reference a group of files
application_service:
files:
- application_service_api.rst
server_server:
files:
- server_server_api.rst
- identity_servers.rst
appendices:
files:
- appendices.rst
groups: # reusable blobs of files when prefixed with 'group:'
modules: