@@ -27,9 +27,40 @@ The below quickstart screen appears as shown below:
**Figure 1 quickstart utility**
For more information on Sphinx Quickstart, refer https://sphinx-rtd-tutorial.readthedocs.io/en/latest/sphinx-quickstart.html.
Defining Document Structure
===========================
sphinx-quickstart creates a source directory with **conf.py** and a **master document**, and **index.rst**. The main function of the master document is to serve as a welcome page, and to contain the root of the “table of contents tree” (or toctree). **index.rst** is the main things that Sphinx adds to reStructuredText, a way to connect multiple files to a single hierarchy of documents.
The toctree directive initially is empty as below:
.. code:: cpp
.. toctree::
:maxdepth: 2
You add documents listing them in the content of the directive:
.. code:: cpp
.. toctree::
:maxdepth: 2
usage/installation
usage/quickstart
For Populating our documentation, refer https://sphinx-rtd-tutorial.readthedocs.io/en/latest/build-the-docs.html
Adding or creating content
==========================
In Sphinx source files, you can use most features of standard reStructuredText. Some of the syntax with examples are explained below:
Publishing the documentation to ReadTheDocs
===========================================
Once documentation is built, procees to upload it to read the docs. To pubish the document to ReadTheDocs, see https://sphinx-rtd-tutorial.readthedocs.io/en/latest/read-the-docs.html.
