Link to doc style doc
(and update it to cover extra section characters)
This commit is contained in:
parent
56547ad373
commit
b5d68b8ff1
2 changed files with 14 additions and 5 deletions
|
@ -87,6 +87,9 @@ matrix-doc should be based on the ``master`` branch.)
|
|||
Code style
|
||||
~~~~~~~~~~
|
||||
|
||||
The documentation style is described at
|
||||
https://github.com/matrix-org/matrix-doc/blob/master/meta/documentation_style.rst.
|
||||
|
||||
Python code within the ``matrix-doc`` project should follow the same style as
|
||||
synapse, which is documented at
|
||||
https://github.com/matrix-org/synapse/tree/master/docs/code_style.rst.
|
||||
|
|
|
@ -19,11 +19,17 @@ RST support lots of different punctuation characters for underlines on sections.
|
|||
Content in the specification MUST use the same characters in order for the
|
||||
complete specification to be merged correctly. These characters are:
|
||||
|
||||
- ``=`` : Top-level sections
|
||||
- ``-`` : Second-level sections
|
||||
- ``~`` : Third-level sections
|
||||
- ``+`` : Fourth-level sections
|
||||
- You should rethink your document layout if you require a fifth level.
|
||||
- ``=``
|
||||
- ``-``
|
||||
- ``~``
|
||||
- ``+``
|
||||
- ``^``
|
||||
- `````
|
||||
- ``@``
|
||||
- ``:``
|
||||
|
||||
If you find yourself using ``^`` or beyond, you should rethink your document
|
||||
layout if possible.
|
||||
|
||||
TODOs
|
||||
-----
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue