The Trusted Firmware-M project uses Sphinx to generate the Official Documentation from Restructed Text .rst source files,
The aim is to align as much as possible with the official Python Documentation Guidelines while keeping the consistency with the already existing files.
The guidance below is provided as a help. It is not meant to be a definitive list.
The following short-list provides a quick summary of the rules.
- If the patch modifies a present file, the file's style should be followed
- If creating a new file,
integration guide </integration_guide/index>can be used as a reference. - When a new style is to be expressed, consult the Python Documentation Guidelines
The following rules should be considered:
- H1 document title headers should be expressed by # with over-line (rows on top and bottom) of the text
- Only ONE H1 header should allowed per document, ideally placed on top of the page.
- H2 headers should be expressed by * with over-line
- H2 header's text should be UNIQUE in per document basis
- H3 headers should be expressed by an underline of '='
- H4 headers should be expressed by an underline of '-'
- H3 and H4 headers have no limitation about naming. They can have similar names on the same document, as long as they have different parents.
- H5 headers should be expressed by an underline of '^'
- H5 headers will be rendered in document body but not in menus on the navigation bar
- Do not use more than 5 levels of heading
- When writing guides, which are expected to be able to be readable by command line tools, it would be best practice to add long complicated tables, and UML diagrams in the bottom of the page and using internal references(auto-label)
- No special formatting should be allowed in Headers (code, underline, strike-through etc)
- Long URLs and external references should be placed at the bottom of the page and referenced in the body of the document
- New introduced terms and abbreviations should be added to Glossary and directly linked by the :term: notation across all documents using it.
The Documentation Build system provides an interface with the platform directory allowing maintainers to bundle platform specific documentation. Platforms are grouped by vendor. This behaviour needs to be explicitly enabled for each vendor's space by providing the <vendor>/index.rst (responsible for generating the Platform Index File </platform/index>) and adding a table of contents entry for the corresponding vendor's space. The format and structure of this entry is not strictly defined, and allows flexible control of vendor's and platform's documentation space. Follow the platform_documentation document for more details.
The section below describes with examples, a rule compliant implementation for most common documentation elements.
###################
Document Title (H1)
###################
******************
Chapter Title (H2)
******************
Chapter Section (H3)
====================
Chapter Sub-Section (H4)
------------------------
Subsection of Chapter sub-section (H5)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^The recommendation for code content, is to use the explicit code-block directive, ideally with a defined lexer for the language the block contains.
A list of compatible lexers can be found at Pygments Lexers
.. code-block:: bash
ls
pwd
.. code-block:: doscon
dir
.. code-block:: c
static struct rn_object_t;
.. code-block:: python3
print("Hello TF-M")Restructured Text supports implicit code-blocks by indenting a section of text, surrounded by new lines. While this formatting is allowed, it should be avoided if possible.
The quick brown fox jumps over the lazy dog
ls
pwdNote
Mixing two different code-block formats in the same document will break the whole document's rendering. When editing an existing document, please follow the existing format.
New documents should always use the explicit format.
For adding new tables the table:: notation should be used.
.. table:: Components table
:widths: auto
+--------------+--------------+-------------+
| **Title A** | **Title B** | **Title C** |
+==============+==============+=============+
| Text A | Text B | Text C |
+--------------+--------------+-------------+While the equivalent simple table code will render correctly in the output, it will not be added to the index (So it cannot be referenced if needed)
+--------------+--------------+-------------+
| **Title A** | **Title B** | **Title C** |
+==============+==============+=============+
| Text A | Text B | Text C |
+--------------+--------------+-------------+Other types of tables such as list-tables and csv-tables are also permitted, as seen on /getting_started/tfm_getting_started and /releases/1.0
External links should be placed in the bottom of a document.
The quick brown fox jumps over the lazy dog according to `Link_A`_
.. _Link_A: https://www.aaa.org
.. _Link_B: https://www.bbb.org
--------------
*Copyright (c) XYZ *Creating in-line links is permitted, but should be avoided if possible. It should be only used for consistency purposes or for a small ammount of short links.
The quick brown fox jumps over the lazy dog according to `Link_A <https://www.aaa.org>`_If for the purposes of content, a link is to be referenced by multiple labels, internal linking is the recommended approach.
The quick brown fox jumps over the lazy dog according to `Link_A_New`_
.. _Link_A: https://www.aaa.org
.. _Link_A_New: `Link_A`_
--------------
*Copyright (c) XYZ *A document included in the documentation can be referenced by the doc: notation
:doc:`integration guide </integration_guide/tfm_integration_guide>`The path is relative to the root of the Trusted Firmware-M code.
Trusted Firmware-M project is spread among multiple repositories: Trusted Firmware-M, TF-M Tests, TF-M Tools and TF-M Extras. Every repository has its own documentation, and since v2.0.0<../releases/2.0.0>, they can be found under Links.
Using Intersphinx, it is now possible to use cross-reference roles from Sphinx to reference documentation from different projects (repositories), like TF-M Tests. Referencing documentation using the doc: notation is preferred and helps to avoid broken cross-references if the link of the document changes.
For example, to get this: Adding TF-M Regression Test Suite
<TF-M-Tests:tfm_test_suites_addition>; the Restructed Text would look like this:
:doc:`Adding TF-M Regression Test Suite <TF-M-Tests:tfm_test_suites_addition>`As can be seen, it is quite similar to cross-referencing in Sphinx, except the path to the document is preceded with the external project name. For TF-M Tests, it is TF-M-Tests. The names of other projects configured to be referenced using Intersphinx can be seen in the conf.py file under intersphinx_mapping.
In order to reference a specific section of a document, up to level 4 headers (if they are included in the index), the ref: keyword can be used
:ref:`docs/getting_started/tfm_getting_started:Tool & Dependency overview`This can also be used to quickly scroll to the specific section of the current document. This technique can be used to add complex table in the bottom of a document and create clickable quick access references to it for improved user experience.
For technical terms and abbreviations, the recommended guidance is to add an entry to the /glossary and refer to it, using the term: directive
HAL
Hardware Abstraction Layer
Interface to abstract hardware-oriented operations and provides a set of
APIs to the upper layers.
.....
As described in the design document :term:`HAL` abstracts the
hardware-oriented and platform specific
.......Note
The ":term:" directive does not work when used in special formatting. Using *HAL* will not link to the glossary term.
Copyright (c) 2020-2023, Arm Limited. All rights reserved.