Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #6307

Merged
merged 23 commits into from
Aug 17, 2023
Merged

Improve documentation #6307

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2e8ee6d
Add install with upgrade option when installing latest development pa…
saurabheights Aug 10, 2023
86e7a2f
util/install-deps-python.sh was removed in https://github.com/isl-org…
saurabheights Aug 10, 2023
3ea347d
Grammar fix.
saurabheights Aug 11, 2023
381882d
Move open3d_ml and arm to after docker.
saurabheights Aug 11, 2023
17a27a3
organize TOC - Move C++ and Contribution to end and keep python secti…
saurabheights Aug 11, 2023
0b8edfd
Fix sphinx warnings (Title underline too short).
saurabheights Aug 11, 2023
201b6bd
Fix extra heading drop when going one level down.
saurabheights Aug 11, 2023
5d798fd
Fix cross reference links
saurabheights Aug 11, 2023
42a1106
Add files/directories to ignore for sphinx, reduces inconsistency war…
saurabheights Aug 12, 2023
4c48feb
Fix `Unknown directive type "code_block"` warning.
saurabheights Aug 12, 2023
9af3bdc
Add uvmaps to official docs, fix - `WARNING: document isn't included …
saurabheights Aug 12, 2023
d71cd20
Fix yaml lexer name - See https://pygments.org/languages/
saurabheights Aug 12, 2023
9c956d2
Correct the extension
saurabheights Aug 12, 2023
fb7c71c
Fix warnings - `Inline substitution_reference start-string without en…
saurabheights Aug 12, 2023
c99fd1b
Minor code refactoring of make_docs.py
saurabheights Aug 13, 2023
af3ba12
Only copy open3d_tutorial.py once
saurabheights Aug 13, 2023
04d8799
Move list of classes to a global variable
saurabheights Aug 14, 2023
3d82438
Use f-strings as requested in PR
saurabheights Aug 14, 2023
549c739
Add python_api_in as ignored directory.
saurabheights Aug 15, 2023
0d675cd
Revert all changes made for correcting vertical bar in pydocs
saurabheights Aug 15, 2023
a3cbf05
Fix pybind docs with literal block for tree output
saurabheights Aug 15, 2023
e807806
Fix doxygen docs with code block for tree output
saurabheights Aug 15, 2023
cfd570f
Correct class names in doxygen docs for RedWood dataset
saurabheights Aug 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cpp_project.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We provide two example CMake projects to demonstrate how to use Open3D in your
CMake projects.

* `Find Pre-Installed Open3D Package in CMake <https://github.com/isl-org/open3d-cmake-find-package>`_
This option can be used if you'd like Open3D build and install Open3D first,
This option can be used if you'd like to build and install Open3D first,
then link your project to Open3D.
* `Use Open3D as a CMake External Project <https://github.com/isl-org/open3d-cmake-external-project>`_
This option can be used if you'd like Open3D to build alongside with your
Expand Down
6 changes: 2 additions & 4 deletions docs/getting_started.in.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ install the latest development version directly with pip:

.. code-block:: bash

pip install --trusted-host www.open3d.org -f http://www.open3d.org/docs/latest/getting_started.html open3d
pip install -U --trusted-host www.open3d.org -f http://www.open3d.org/docs/latest/getting_started.html open3d
saurabheights marked this conversation as resolved.
Show resolved Hide resolved

.. note::
The development wheels for Linux are named according to PEP600. Please
Expand Down Expand Up @@ -144,9 +144,7 @@ demonstrate the usage of Open3D Python interface. See ``examples/python`` for
all Python examples.

.. note:: Open3D's Python tutorial utilizes some external packages: ``numpy``,
``matplotlib``, ``opencv-python``. OpenCV is only used for reconstruction
Copy link
Contributor Author

@saurabheights saurabheights Aug 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed missing shell script, as well as why Opencv is used (most users dont care about that) and also its easy to make this doc redundant when adding a new example where opencv is used (which might have already happened, I do need to check if numpy, matplotlib, opencv-python are the only needed libs. Maybe adding etc. and some requirements_example.txt file would be better.

system. Please read ``util/install-deps-python.sh`` for installing these
packages.
``matplotlib``, ``opencv-python``.

.. _install_open3d_c++:

Expand Down
38 changes: 19 additions & 19 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Open3D: A Modern Library for 3D Data Processing
compilation
cpp_project
builddocs
open3d_ml
arm
docker
arm
open3d_ml
Copy link
Contributor Author

@saurabheights saurabheights Aug 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved open3d_ml to the bottom and arm above, with docker option closer to right after compilation, since new user would want to see how to get started with open3d faster. Let me know if this is alright or not.


.. toctree::
:maxdepth: 2
Expand All @@ -46,23 +46,6 @@ Open3D: A Modern Library for 3D Data Processing
tutorial/sensor/index
tutorial/reference

.. toctree::
:maxdepth: 1
:caption: Contribute

contribute/contribute
contribute/contribution_recipes
contribute/styleguide

.. toctree::
:maxdepth: 1
:caption: C++ API

cpp_api

..
Note: when adding new modules, please also update documented_modules.txt.

.. toctree::
:maxdepth: 1
:caption: Python API
Expand All @@ -88,3 +71,20 @@ Open3D: A Modern Library for 3D Data Processing
python_example/pipelines/index
python_example/utility/index
python_example/visualization/index

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As previous commit, this one focuses on putting all python related stuff together, i.e. Tutorials, Python API and Python Examples. C++ API after Python and Contribution in the end.

Screenshot from 2023-08-12 18-01-55

Screenshot from 2023-08-12 18-02-09

.. toctree::
:maxdepth: 1
:caption: C++ API

cpp_api

.. toctree::
:maxdepth: 1
:caption: Contribute

contribute/contribute
contribute/contribution_recipes
contribute/styleguide

..
Note: when adding new modules, please also update documented_modules.txt.