docs: Sphinx + ReadTheDocs #2710
Conversation
|
@adehad, Feel free to chyme in on this one with design choices etc. |
| - path: docs | ||
| extra_requirements: | ||
| - docs | ||
| build: |
There was a problem hiding this comment.
Would be awesome if we could add doxygen and graphviz to the readthedocs build environment:
https://docs.readthedocs.io/en/stable/config-file/v2.html#build-apt-packages
Then we could include a command within the conf.py to build the source documentation as well. This can be included in its own section of the docs, perhaps named "API Reference".
Note: Technically the readthedocs agents already include doxygen, but I think being explicit can't hurt!
There was a problem hiding this comment.
Ok, I've added the doxygen. It is a mess now because it is all in one place instead of using groups or manually curating the api
There was a problem hiding this comment.
Would appreciate a bit of help. Can you find a way to move the doxygen folder back to /docs/doxygen and not have it loop recursively when running sphinx-autobuild? I have tried adding it to exclude_patterns, but that did not do the trick.
There was a problem hiding this comment.
I can have a look, I have limited availability for a while, but can update you if I figure anything out
Codecov Report
@@ Coverage Diff @@
## devel #2710 +/- ##
=======================================
Coverage 91.19% 91.19%
=======================================
Files 192 192
Lines 7843 7843
=======================================
Hits 7152 7152
Misses 691 691 |
Regarding #2709, here is the sphinx version for comparison as well. For now the generated documentation can be viewed at:
https://catch2-temp.readthedocs.io/en/latest/