Skip to content

pybind module is not fully documented #64

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

Open
9and3 opened this issue Aug 16, 2024 · 0 comments
Open

pybind module is not fully documented #64

9and3 opened this issue Aug 16, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@9and3
Copy link
Contributor

9and3 commented Aug 16, 2024

In the sphinx documentation of the python API the pybind is correctly reported but it is missing docstrings cannot be parsed into the html.

We should refactor the system to better docstring the pybind.

e.g.:

image

@9and3 9and3 added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 16, 2024
@9and3 9and3 self-assigned this Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant