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 all 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
166 changes: 83 additions & 83 deletions cpp/open3d/data/Dataset.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,26 +723,26 @@ class PaintedPlasterTexture : public DownloadDataset {
/// cloud, rgb sequence, clean depth sequence, noisy depth sequence, oni
/// sequence, and ground-truth camera trajectory.
///
/// RedwoodIndoorLivingRoom1
/// ├── colors
/// │ ├── 00000.jpg
/// │ ├── 00001.jpg
/// │ ├── ...
/// │ └── 02869.jpg
/// ├── depth
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02869.png
/// ├── depth_noisy
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02869.png
/// ├── dist-model.txt
/// ├── livingroom1.oni
/// ├── livingroom1-traj.txt
/// └── livingroom.ply
/// RedwoodIndoorLivingRoom1
/// ├── colors
/// │ ├── 00000.jpg
/// │ ├── 00001.jpg
/// │ ├── ...
/// │ └── 02869.jpg
/// ├── depth
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02869.png
/// ├── depth_noisy
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02869.png
/// ├── dist-model.txt
/// ├── livingroom1.oni
/// ├── livingroom1-traj.txt
/// └── livingroom.ply
class RedwoodIndoorLivingRoom1 : public DownloadDataset {
public:
RedwoodIndoorLivingRoom1(const std::string& data_root = "");
Expand Down Expand Up @@ -775,30 +775,30 @@ class RedwoodIndoorLivingRoom1 : public DownloadDataset {
};

/// \class RedwoodIndoorLivingRoom2 (Augmented ICL-NUIM Dataset)
/// \brief Data class for `RedwoodIndoorLivingRoom1`, containing dense point
/// \brief Data class for `RedwoodIndoorLivingRoom2`, containing dense point
/// cloud, rgb sequence, clean depth sequence, noisy depth sequence, oni
/// sequence, and ground-truth camera trajectory.
///
/// RedwoodIndoorLivingRoom2
/// ├── colors
/// │ ├── 00000.jpg
/// │ ├── 00001.jpg
/// │ ├── ...
/// │ └── 02349.jpg
/// ├── depth
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02349.png
/// ├── depth_noisy
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02349.png
/// ├── dist-model.txt
/// ├── livingroom2.oni
/// ├── livingroom2-traj.txt
/// └── livingroom.ply
/// RedwoodIndoorLivingRoom2
/// ├── colors
/// │ ├── 00000.jpg
/// │ ├── 00001.jpg
/// │ ├── ...
/// │ └── 02349.jpg
/// ├── depth
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02349.png
/// ├── depth_noisy
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02349.png
/// ├── dist-model.txt
/// ├── livingroom2.oni
/// ├── livingroom2-traj.txt
/// └── livingroom.ply
class RedwoodIndoorLivingRoom2 : public DownloadDataset {
public:
RedwoodIndoorLivingRoom2(const std::string& data_root = "");
Expand Down Expand Up @@ -831,30 +831,30 @@ class RedwoodIndoorLivingRoom2 : public DownloadDataset {
};

/// \class RedwoodIndoorOffice1 (Augmented ICL-NUIM Dataset)
/// \brief Data class for `RedwoodIndoorLivingRoom1`, containing dense point
/// \brief Data class for `RedwoodIndoorOffice1`, containing dense point
/// cloud, rgb sequence, clean depth sequence, noisy depth sequence, oni
/// sequence, and ground-truth camera trajectory.
///
/// RedwoodIndoorOffice1
/// ├── colors
/// │ ├── 00000.jpg
/// │ ├── 00001.jpg
/// │ ├── ...
/// │ └── 02689.jpg
/// ├── depth
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02689.png
/// ├── depth_noisy
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02689.png
/// ├── dist-model.txt
/// ├── office1.oni
/// ├── office1-traj.txt
/// └── office.ply
/// RedwoodIndoorOffice1
/// ├── colors
/// │ ├── 00000.jpg
/// │ ├── 00001.jpg
/// │ ├── ...
/// │ └── 02689.jpg
/// ├── depth
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02689.png
/// ├── depth_noisy
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02689.png
/// ├── dist-model.txt
/// ├── office1.oni
/// ├── office1-traj.txt
/// └── office.ply
class RedwoodIndoorOffice1 : public DownloadDataset {
public:
RedwoodIndoorOffice1(const std::string& data_root = "");
Expand Down Expand Up @@ -887,30 +887,30 @@ class RedwoodIndoorOffice1 : public DownloadDataset {
};

/// \class RedwoodIndoorOffice2 (Augmented ICL-NUIM Dataset)
/// \brief Data class for `RedwoodIndoorLivingRoom1`, containing dense point
/// \brief Data class for `RedwoodIndoorOffice2`, containing dense point
/// cloud, rgb sequence, clean depth sequence, noisy depth sequence, oni
/// sequence, and ground-truth camera trajectory.
///
/// RedwoodIndoorOffice2
/// ├── colors
/// │ ├── 00000.jpg
/// │ ├── 00001.jpg
/// │ ├── ...
/// │ └── 02537.jpg
/// ├── depth
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02537.png
/// ├── depth_noisy
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02537.png
/// ├── dist-model.txt
/// ├── office2.oni
/// ├── office2-traj.txt
/// └── office.ply
/// RedwoodIndoorOffice2
/// ├── colors
/// │ ├── 00000.jpg
/// │ ├── 00001.jpg
/// │ ├── ...
/// │ └── 02537.jpg
/// ├── depth
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02537.png
/// ├── depth_noisy
/// │ ├── 00000.png
/// │ ├── 00001.png
/// │ ├── ...
/// │ └── 02537.png
/// ├── dist-model.txt
/// ├── office2.oni
/// ├── office2-traj.txt
/// └── office.ply
class RedwoodIndoorOffice2 : public DownloadDataset {
public:
RedwoodIndoorOffice2(const std::string& data_root = "");
Expand Down
Loading