Open
Conversation
Wentzell
force-pushed
the
DEV_DOXYGEN
branch
from
8d850bf to
764eabc
Compare
- update doxygen docstrings in c++ files - add basic doxygen setup to doc/doxygen -> generate doxygen docs with cmake and link them to the sphinx docs - Add basic doxygen configuration and integration with sphinx - Update C++ docstrings and generate doxygen docs via cmake - Refine python docstring processing approach using numpydoc - Update autosummary templates following scipy/numpy conventions - Handle undocumented classes and update generated python bindings
Wentzell
force-pushed
the
DEV_DOXYGEN
branch
from
764eabc to
5f6acd2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We are using numpydoc style doc strings. To make them look good, we are processing the doc strings in
conf.pyto inject parameter and return types of functions. It might be better to do this directly in c2py/clair (if possible).