Building Documentation¶
The main documentation and Python documentation is written in reStructuredText and generated by sphinx. The C++ API documentation is generated by Doxygen.
Prerequisites¶
1. Build Open3D from source¶
Clone and build Open3D from source. Visit Compiling from source for details.
2. Install Sphinx¶
# For pip
pip install sphinx sphinx-autobuild
# Or, for Conda
conda install sphinx sphinx-autobuild
3. Install Doxygen¶
Ubuntu
sudo apt-get -y install doxygen
macOS
brew install doxygen
Windows
Visit Doxygen downloads page to checkout the source or binaries.
Build¶
cd docs
# You may optionally select the --sphinx --doxygen flag
python make_docs.py --sphinx --doxygen
The docs html will be saved in docs/_out
folder.