bifrost
bifrost copied to clipboard
Update docs
Clarify build instructions in the README file for users who are not using Docker.
Add information on making new packet formats in the C++ development section of the docs.
Some other things to think about:
- Should the Makefile in docs also run doxygen as part of building the docs?
- Should there be some toggle in
configure/a Makefile that makes things work even without doxygen? - Should we also test for sphinx/breathe or something like
extras_requirein the setup.py? - Should the top-level Makefile have a
make docsoption that builds everything if Python/doxygen are installed?
I've made some changes to configure. It now:
- emits a warning if
doxygenisn't found about how the docs cannot be built - tests for the
sphinx-build,sphinx-apidoc, andbreathe-apidocscripts - emits a warning if
sphinx-*orbreathe-apidocare not found about how the Python docs cannot be built - updates
make docto build all possible docs with the Python stuff built as "singlehtml" - updates docs/Makefile to a .in file so that it is consistent with all other build files and uses the configure-detected values for the paths.
I think that covers it. We should also update master once we're happy with these doc build changes.
I made quite a few changes to the README. Let me know what you think \