Creating the HTML Basilisk Documentation using Sphinx/Doxygen¶
The Sphinx and Doxygen software packages provide an elegant method to both include code explanations, definitions and module documentation, but also to create a full HTML based documentation folder for a software project. An online copy of this HTML documentation is hosted at AVS Basilisk web site with the Documentation page.
You need to have a command line version of Doxygen installed on your system. The Doxygen download page contains a range of pre-compiled binaries for many different platforms.
On macOS the Homebrew tool is also a very convenient method to install Doxygen by typing in the terminal:
brew install doxygen
See Installing Optional Packages to learn what python packages must be installed.
Making the HTML Documentation Folder¶
To create the HTML documentation with all the associated scenario
figures, be sure to run
pytest first from within the
Next, in a terminal window switch to the
Finally, type the following command to build the HTML documenation:
The final html documenation folder is stored in
To clean out the sphinx generated documents and folder use:
To open the HTML index file and view the documentation in the browser use: