Add index page
This commit is contained in:
parent
aaeaa1dd98
commit
8eb84612f2
3 changed files with 29 additions and 26 deletions
25
specification/index.rst
Normal file
25
specification/index.rst
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
Matrix Specification
|
||||||
|
====================
|
||||||
|
|
||||||
|
This specification has been generated from
|
||||||
|
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}}.
|
||||||
|
|
||||||
|
The following APIs are documented in this specification:
|
||||||
|
|
||||||
|
- `Client-Server API <client_server.html>`_ version %CLIENT_RELEASE_LABEL% for writing Matrix clients.
|
||||||
|
- `Server-Server API <server_server.html>`_ version %SERVER_RELEASE_LABEL% for writing servers which can federate with Matrix.
|
||||||
|
- `Application Service API <application_service.html>`_ version %CLIENT_RELEASE_LABEL% for writing privileged plugins to servers.
|
||||||
|
|
||||||
|
There is also an `introduction with overview <intro.html>`_, and some `appendices <appendices.html>`_.
|
||||||
|
|
||||||
|
Any developments since the latest release can be found `here`__.
|
||||||
|
|
||||||
|
.. __: https://matrix.org/speculator/spec/head/
|
||||||
|
|
||||||
|
Before we formally started releasing the specification, the last working copy
|
||||||
|
we had can be found `here`__.
|
||||||
|
|
||||||
|
.. __: https://matrix.org/docs/spec/legacy/
|
|
@ -1,28 +1,3 @@
|
||||||
Matrix Specification
|
|
||||||
====================
|
|
||||||
|
|
||||||
This specification has been generated from
|
|
||||||
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}}.
|
|
||||||
|
|
||||||
The following APIs are documented in this specification:
|
|
||||||
|
|
||||||
- `Client-Server API <client_server.html>`_ version %CLIENT_RELEASE_LABEL% for writing Matrix clients.
|
|
||||||
- `Server-Server API <server_server.html>`_ version %SERVER_RELEASE_LABEL% for writing servers which can federate with Matrix.
|
|
||||||
- `Application Service API <application_service.html>`_ version %CLIENT_RELEASE_LABEL% for writing privileged plugins to servers.
|
|
||||||
|
|
||||||
There are also some `appendices <appendices.html>`_.
|
|
||||||
|
|
||||||
Any developments since the latest release can be found `here`__.
|
|
||||||
|
|
||||||
Before we formally started releasing the specification, the last working copy
|
|
||||||
we had can be found `here`__.
|
|
||||||
|
|
||||||
.. __: https://matrix.org/speculator/spec/head/
|
|
||||||
.. __: https://matrix.org/docs/spec/legacy/
|
|
||||||
|
|
||||||
.. contents:: Table of Contents
|
.. contents:: Table of Contents
|
||||||
.. sectnum::
|
.. sectnum::
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,9 @@
|
||||||
targets:
|
targets:
|
||||||
index:
|
index:
|
||||||
files: # the sort order of files to cat
|
files:
|
||||||
|
- index.rst
|
||||||
|
intro:
|
||||||
|
files:
|
||||||
- intro.rst
|
- intro.rst
|
||||||
client_server:
|
client_server:
|
||||||
files:
|
files:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue