Skip to content

Commit

Permalink
Improve documentation (#6307)
Browse files Browse the repository at this point in the history
* Add install with upgrade option when installing latest development package.
* util/install-deps-python.sh was removed in #2146
* Grammar fix.
* Move open3d_ml and arm to after docker.
* organize TOC - Move C++ and Contribution to end and keep python section together.
* Fix sphinx warnings (Title underline too short).
* Fix extra heading drop when going one level down.
* Fix cross reference links
* Add files/directories to ignore for sphinx, reduces inconsistency warnings.
* Fix `Unknown directive type "code_block"` warning.
* Add uvmaps to official docs, fix - `WARNING: document isn't included in any toctree`.
* Fix yaml lexer name - See https://pygments.org/languages/
* Fix warnings - `Inline substitution_reference start-string without end-string.`
* Only copy open3d_tutorial.py once
* Move list of classes to a global variable
* Use f-strings as requested in PR
* Add python_api_in as ignored directory.
* Fix pybind docs with literal block for tree output
* Fix doxygen docs with code block for tree outpu
* Correct class names in doxygen docs for RedWood dataset
  • Loading branch information
saurabheights authored Aug 17, 2023
1 parent 1012819 commit c7718fd
Show file tree
Hide file tree
Showing 15 changed files with 281 additions and 249 deletions.
166 changes: 83 additions & 83 deletions cpp/open3d/data/Dataset.h
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

0 comments on commit c7718fd

Please sign in to comment.