| Julian Hall | 2075a21 | 2021-03-24 10:11:29 +0000 | [diff] [blame^] | 1 | Writing Documentation |
| Julian Hall | e76ade8 | 2020-11-25 03:07:21 +0100 | [diff] [blame] | 2 | ===================== |
| 3 | |
| 4 | |TS| is documented using `Sphinx`_, which in turn uses Docutils and `Restructured Text`_ (|REST| hereafter). |
| 5 | |
| 6 | The source files for the documents are in the *docs* directory of the |TS_REPO|. |
| 7 | |
| 8 | The preferred output format is *HTML*, and other formats may or may not work. |
| 9 | |
| 10 | |
| 11 | Section Headings |
| 12 | ---------------- |
| 13 | |
| 14 | In order to avoid problems if documents include each other, it is important to follow a consistent section heading |
| 15 | style. 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 | |
| 33 | Inline documentation |
| 34 | -------------------- |
| 35 | |
| 36 | To get all information integrated into a single document the project uses Sphinx extensions to allow capturing inline |
| 37 | documentation into this manual. |
| 38 | |
| 39 | |
| 40 | CMake |
| 41 | ''''' |
| 42 | |
| 43 | .. todo:: Add content about how to document cmake scripts. |
| 44 | |
| 45 | |
| 46 | -------------- |
| 47 | |
| 48 | .. _`Restructured Text`: https://docutils.sourceforge.io/rst.html |
| 49 | .. _`Sphinx`: https://www.sphinx-doc.org |
| 50 | |
| 51 | *Copyright (c) 2020-2021, Arm Limited and Contributors. All rights reserved.* |
| 52 | |
| 53 | SPDX-License-Identifier: BSD-3-Clause |