External Documentation#

How to build#

In the docs folder or the internal_docs folder you can:

Clean Out the Build:#

make.bat clean

Build HTML:#

make.bat html

After the html is build you can open up the files by opening:

docs/build/html/index.html

RST Reference#

Sphinx RST Primer

Docutils RST Reference

Sphinx Design Reference

File Structure#

docs or internal_docs folder:

  • source:

    • Contains the source code the restructured text that is compiled by Sphinx into another form

  • build:

    • Contains build artifacts after running make.bat

    • Note that this folder is ignored in the gitignore file

  • source/conf.py

    • This is the configuration python file that tells Sphinx how to build the source

  • source/index.rst

    • This is the starting restructured text file. In the Toctree it will rerference all other docs

  • source/_static

    • Folder that will contain static references for the html pages such as CSS and JS fils

  • source/_template

    • Folder that will contain template files to format the html output of sphinx (not currently using this)

  • source/other folders

    • Any other folders are expected to have an index.rst file in them and should be linked in by their parent index.rst in the toctree

Adding External Libraries#

  1. pip install <library you want>

  2. Add that library reference to the extensions list in conf.py