Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Sphinx + ReadTheDocs #2710

Open
wants to merge 5 commits into
base: devel
Choose a base branch
from
Open

Conversation

LecrisUT
Copy link
Contributor

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/

@LecrisUT
Copy link
Contributor Author

@adehad, Feel free to chyme in on this one with design choices etc.

- path: docs
extra_requirements:
- docs
build:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can have a look, I have limited availability for a while, but can update you if I figure anything out

@codecov
Copy link

codecov bot commented Jun 27, 2023

Codecov Report

Merging #2710 (afe0ca2) into devel (e4b1605) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            devel    #2710   +/-   ##
=======================================
  Coverage   91.19%   91.19%           
=======================================
  Files         192      192           
  Lines        7843     7843           
=======================================
  Hits         7152     7152           
  Misses        691      691           

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants