Markus Braun
Markus Braun
Right now we still use Sphinx 4.5 - mainly because the theme we're using (sphinx-books) wasn't compatible with newer sphinx releases last time we checked (been some time)... Meanwhile sphinx-books...
The documentation for the release process is still missing. It should be documented here: [docs/release_process.md](../blob/feature/1_contribute_doxysphinx/docs/release_process.md)
Add an example of using needs to link between code and documentation files. File: [docs/linking_needs.md](../blob/feature/1_contribute_doxysphinx/docs/linking_needs.md)
**⚠️ Problem** E.g. when using a doxysphinx call like this: ``` doxysphinx /workspaces/doxysphinx ../build/doxygen_docs doxygen/ ``` The following error will occur: ``` ValueError: '/workspaces/build/doxygen_docs/doxygen' is not in the subpath of...
As discussed in the comments of #84 supporting rst inline syntax directly would be helpful for migrating from and to breathe based documentation. This would involve heavy parsing for sure...
When we did the 3.0.0 Release the release notes were empty. Todos: - Analyse root cause (Commitzen, Pipeline Issue, perhaps only with breaking change commits?) - Fix it.
RTD Theme supports, "Edit on GitHub" which helps navigate to sources in GitHub. It would be nice if doxysphinx generated HTMLs could navigate to its corresponding hpp/cpp. Example `conf.py` ```python...
The docs build of doxysphinx could be a good self-test when activating warnings as errors in sphinx. However at present there are some warnings that need to be fixed/handled.
Implement myst-markdown support for doxygen documentation. As doxygen itself has markdown support this might bring a tighter integration syntax-wise. Eventually we could then leave out the \rst and \endrst tags...
As [doxylink](https://github.com/sphinx-contrib/doxylink) is a very valuable tool for linking back to doxygen documentation from rst. We could provide a little helper that could be used in conf.py to autogenerate the...