Changed namespace fix to use Sphinx autodoc-process-* events#7103
Merged
benjaminum merged 2 commits intoisl-org:mainfrom Dec 19, 2024
Merged
Changed namespace fix to use Sphinx autodoc-process-* events#7103benjaminum merged 2 commits intoisl-org:mainfrom
benjaminum merged 2 commits intoisl-org:mainfrom
Conversation
|
Thanks for submitting this pull request! The maintainers of this repository would appreciate if you could update the CHANGELOG.md based on your changes. |
Contributor
Author
|
Documentation CI was already failing in previous commits. The following packages have unmet dependencies:
cmake : Depends: libssl1.1 (>= 1.1.1) but it is not installableThe following is the function installing docs dependencies. Lines 338 to 375 in 0ae7b1a |
benjaminum
approved these changes
Dec 19, 2024
Contributor
benjaminum
left a comment
There was a problem hiding this comment.
@timohl This is great! Thanks!
We are moving away from the *Inject functions to simplify writing docstrings.
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
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.
Type
Motivation and Context
Open3D uses namespaces
open3d.cpu.pybind.andopen3d.cuda.pybind.to differentiate between both device builds.This adds a lot of clutter to the documentation (see screenshots below).
There is already a partial fix for functions documented using
docstring::ClassMethodDocInjectanddocstring::FunctionDocInject.However, a big part of Open3D does not use those functions for documentation and #7081 removed those from the contribute docs (so they should probably be avoided in the future).
Checklist:
python util/check_style.py --applyto apply Open3D code styleto my code.
updated accordingly.
results (e.g. screenshots or numbers) here.
Description
This PR moves the namespace fix away from
docstring::ClassMethodDocInjectanddocstring::FunctionDocInjectto the sphinx documentation generation.It uses the autodoc events
autodoc-process-signatureandautodoc-process-docstringto change namespaces toopen3d.during doc generation.With this PR all namespaces are fixed in the documentation (checked using the search function).
This is a fix used in #6917 since mypy would complain about missing imports for functions with fixed namespaces.
Notice in the following before/after screenshots that the namespaces in the
clearfunction were already fixed due to usingdocstring::ClassMethodDocInject. This PR improves the namespaces in__init__andas_tensorthough, resulting in better readability.Here before:


and after: