1.6. Adding a new section to the document¶
Create a new .md
and write the content in the markdown language, e.g.
newsection.md
.
Add this .md
file to the GDA Developer/User Guide source directory,
for the Developer Guide this is gda-documentation/GDA_Developer_Guide/source/
and User Guide is gda-documentation/GDA_User_Guide/source/
.
Importantly, so as to not get warnings in the make, this file must be added to
the ‘Table of Contents’. The file containing the Developer Guide
Table of Contents is gda-documentation/GDA_Developer_Guide/contents.rst
and User Guide is gda-documentation/GDA_User_Guide/contents.rst/
.
In the file contents.rst
, add the name of the new file excluding the
suffix .md to the list in the appropriate place that it should appear in
the document.
E.g.: Add newsection to the GDA Developer Guide contents file:
documentation.gda/GDA_Developer_Guide/contents.rst
Contents:
.. toctree::
:maxdepth: 2
:numbered:
introduction
middle
newsection
conclusion
Then build the documentation following the instructions in section Building the GDA Developer and User Guides at Diamond.