Required Tutorials

After confirming the virtual environment is active and having navigated to your sandbox, start going through the official Sphinx Tutorial, as it’s foundational to working w/ rST and being productive with the other Sphinx extensions.

Then, go through the following sequence of tutorials:

  1. Sphinx-Needs Tutorial

  2. Mermaid Tutorial

  3. Wavedrom Tutorial

This will provide you with the background required to make sense of the documentation template’s directory structure ROOT_DIR/docs/ and source files in ROOT_DIR/docs/source/ to start modifying it.