Skip to content

Some fixes for the documentation - #50

Merged
RaulPPelaez merged 7 commits into
mainfrom
docs_fix
Jun 26, 2025
Merged

Some fixes for the documentation#50
RaulPPelaez merged 7 commits into
mainfrom
docs_fix

Conversation

@RaulPPelaez

Copy link
Copy Markdown
Contributor

Many signatures were missing in the rendered documentation. I also fixed/completed some docstrings.

@github-actions

Copy link
Copy Markdown

Linter reported no issues

All Python files are correctly formatted with Black.

@github-actions

Copy link
Copy Markdown

Linter reported no issues

All C/C++ files are correctly formatted with clang-format.

@RaulPPelaez

Copy link
Copy Markdown
Contributor Author

@rykerfish It turns out that nanobind does something a bit nasty with the signatures when presenting the methods that come from C++ to Python. Since Sphinx uses that for automatic documentation many functions where being rendered strangely, like without arguments and so on and so forth.

It was similar with pybind, but the rules are a bit different for nanobind. This PR fixes that and some other issues with the documentation in general (like missing or repeated information, references, etc).

@RaulPPelaez

Copy link
Copy Markdown
Contributor Author

I am going to merge this one now and fix the conflicts that will probably arise in #49 due to it.

@RaulPPelaez
RaulPPelaez merged commit a155eef into main Jun 26, 2025
4 checks passed
@RaulPPelaez
RaulPPelaez deleted the docs_fix branch June 26, 2025 09:31
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.

1 participant