1.1. Introduction¶
This document, and its companion GDA User Guide, are created using Sphinx - a documentation generator (written in Python) which converts text files containing markup (including reStructuredText and markdown) into HTML websites and other formats.
The primary markup language used to create this documentation is markdown (.md) therefore all document content should be written in this language. Only files to configure the Sphinx build of the document are written in reStructuredText (.rst), for example the Table Of Contents (TOC) is created using ‘contents.rst’. Currently Sphinx does not fully support a clean way of creating the TOC with markdown therefore reStructuredText is used.
Other formatting preferences may not currently be available in markdown. In which case lines of reStructuredText can be embedded within the markdown document (see section Embedding reStructuredText ).