-
Notifications
You must be signed in to change notification settings - Fork 60
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
Introduce the infrastructure for auto-generating API documentation via sphinx and doxygen #383
Conversation
d0a06f1
to
497d48f
Compare
3e5f677
to
2f14fea
Compare
31d2f9c
to
cf8230e
Compare
This currently includes configuration for publishing via |
cf8230e
to
933d9d7
Compare
Removed the readthedocs configuration again and instead went for an attempt that uses The current result can be seen here at https://tmadlener.github.io/podio What this does not yet do and where I think we might actually need some dedicated scripting:
Another slight disadvantage of We could also think about splitting the automatic (re-)generatiaon and (re-)deploying to wherever we choose to host this in the end into a separate PR to at least have something that allows users to generate readable documentation locally. |
933d9d7
to
19135c3
Compare
I have removed the |
7abfc83
to
daf1a33
Compare
doxygen -u Doxyfile.in
daf1a33
to
c720965
Compare
BEGINRELEASENOTES
sphinx
for generating documentationdoxygen
for generating the c++ files and then usebreathe
to integrate that into thesphinx
generated documentationsphinx
ENDRELEASENOTES
This is currently using the read the docs sphinx theme, but we can in principle switch to anything else. The
Sphinx
target is not built automatically even ifCREATE_DOC
is enabled.This introduces the basic infrastructure to run doxygen as well as autodoc within sphinx to generate API documentation from docstrings automatically. It furthermore also produces the other documentation from the markdown files in
doc
. I think actually fixing the content of the documentation can go to subsequent PRs, where we can also address smaller style changes.Additionally, this PR also does not solve the question on where to host the versioned documentation. For now this will just push the things to the
gh-pages
branch, which will automatically publish it on github pages.