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.
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
Improve documentation #6307
Improve documentation #6307
Changes from 1 commit
2e8ee6d
86e7a2f
3ea347d
381882d
17a27a3
0b8edfd
201b6bd
5d798fd
42a1106
4c48feb
9af3bdc
d71cd20
9c956d2
fb7c71c
c99fd1b
af3ba12
04d8799
3d82438
549c739
0d675cd
a3cbf05
e807806
cfd570f
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The issue comes from vertical bars in python docs which are from tree command - http://open3d.org/docs/release/python_api/open3d.data.RedwoodIndoorLivingRoom1.html. This change fixes the warning but the output is in html paragraph tag and new lines get ignored.
There was an alternate option to also remove output of tree command from docs, but I thought better keep tree output. Python docs are nicer, even if sphinx is not yet. Any ideas on how to fix for sphinx as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @saurabheights this issue actually originates from C++ code where the doc string is written, so the best way to fix this is there. We should not need a python postprocessing script here. The doscstring is rst and the rst syntax for literal text is:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks
(double colon and indented block)
Can you switch the pybind docstring to this syntax and see if that fixes this issue?
The pybind docstring is here:
https://github.com/isl-org/Open3D/blob/master/cpp/pybind/data/dataset.cpp#L979
Similarly, the C++ doxygen documentation is also mis-formatted:
http://www.open3d.org/docs/latest/cpp_api/classopen3d_1_1data_1_1_redwood_indoor_living_room1.html#details
Doxygen uses markdown syntax for code blocks:
https://www.doxygen.nl/manual/markdown.html#mddox_code_blocks
Here is the C++ documentation:
https://github.com/isl-org/Open3D/blob/master/cpp/open3d/data/Dataset.h#L726
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ssheorey Thanks for catching this. Learnt something new. Reverted my earlier postprocessing script and added suggested solution. Worked nicely for both sphinx and doxygen.