Documentation Guide

Language & Framework

The documentation is written using Sphinx

The language use by Sphinx is a extended version of ReStructuredText

The documentation uses Sphinx Material Theme as the theme used for rendering the documentation

How to build the Documentation

In the Sphinx Documentation directory, execute the following command according to you operating system:

Windows (CMD)

make.bat html

Windows (Bash)

./make.bat html

MacOS

make html

Examples

The best examples can be found on the Sphinx Material Online Documentation, which is built using Sphinx-Material itself.

You can check the code of these examples directly by checking the corresponding Sphinx Material Github Branch.

To see the actual ReStructuredText code of an example, click on the corresponding “.rst” file and click on “Raw”.

Example with “Additional Sample” :