How to Build the Documentation from a Sphinx project¶
Load the file
index.html into your browser and examine the results.
The file path is different depending if you have an in-source or
- in-source path:
- out-of-source path:
For our testing purposes, we’ll document the aalength.mac macro file from the Install section. Edit the new file index.rst and add this line at line 14. Make sure it lines up at the left in column 1:
.. autospecmacro:: ../specdomain/doc/aalength.mac
Build the HTML documentation:
View the documentation using a web browser such as firefox:
firefox _build/html/index.html &
You should see a page that looks like this, if nothing went wrong.