Sphinx documentation is broken
The update to Dune v2.5 broke the Sphinx documentation. Apparently, the new Dune macros use a new syntax. At the moment, make doc
produces a documentation of the entire CMake API included in Dorie.
Solution: Explicitly call Sphinx via CMake like in this example Use the macro with the new syntax as it is done in dune-testtools.
Preliminary tasks:
- create new
conf.py.in
file using sphinx-quickstart - install Sphinx into the Dune
venv
- execute Sphinx inside Dune
venv
when callingmake doc
or similar
- execute Sphinx inside Dune
change syntax ofdune_cmake_sphinx_doc()
- check Breathe functionality
To upload designs, you'll need to enable LFS and have admin enable hashed storage. More information