Closed wmalpica closed 3 years ago
Outlining the build process so we do not check in unnecessary files:
docsrc
folder. This folder shall only contain source files necessary for building the docs (RST of static files, configuration, etc.) It shall NOT contain any of the RST files generated by Doxygen from the C++ side: these will be generated automatically when the GitHub actions run.main
branch, the GitHub actions shall run make
inside docsrc
and build all the files to serve the documentation: the breathe
and exhale
will then run Doxygen and build the API docs pages for the C++ side, and the rest of the Sphinx process will scrape the Python scripts for all the docstrings and create the final HTML view of the documentation.build
folder will be moved/overwrite the docs
folder in the root of the repo where Github pages will serve it.rerun tests