1Writing Documentation
2=====================
3
4|TS| is documented using `Sphinx`_, which in turn uses Docutils and `Restructured Text`_ (|REST| hereafter).
5
6The source files for the documents are in the *docs* directory of the |TS_REPO|.
7
8The preferred output format is *HTML*, and other formats may or may not work.
9
10
11Section Headings
12----------------
13
14In order to avoid problems if documents include each other, it is important to follow a consistent section heading
15style. Please use at most five heading levels. Please use the following style::
16
17    First-Level Title
18    =================
19
20    Second-Level Title
21    ------------------
22
23    Third-Level Title
24    '''''''''''''''''
25
26    Forth-level Title
27    """""""""""""""""
28
29    Fifth-level Title
30    ~~~~~~~~~~~~~~~~~
31
32
33Inline documentation
34--------------------
35
36To get all information integrated into a single document the project uses Sphinx extensions to allow capturing inline
37documentation into this manual.
38
39
40CMake
41'''''
42
43The project uses the ""`moderncmakedomain`_" Sphinx extension. This allows adding inline documentation to cmake files.
44For details please refer to the documentation of the plugin.
45
46--------------
47
48.. _`Restructured Text`: https://docutils.sourceforge.io/rst.html
49.. _`Sphinx`: https://www.sphinx-doc.org
50.. _`moderncmakedomain`: https://github.com/scikit-build/moderncmakedomain
51
52*Copyright (c) 2020-2022, Arm Limited and Contributors. All rights reserved.*
53
54SPDX-License-Identifier: BSD-3-Clause
55