1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
.. _builddocs:
Build documentation
======================
The main documentation and Python documentation is written in
`reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_ and
generated by `sphinx <http://www.sphinx-doc.org/>`_. The C++ API documentation
is generated by `Doxygen <http://www.doxygen.nl/>`_.
Documentation can be built on Ubuntu or macOS. Building documentation on Windows
may also be possible but it is not officially tested.
If you're building documentation on a computer without a display, please use
:ref:`headless_rendering`, otherwise the Jupyter tutorials will fail to execute.
Prerequisites
-------------
1. Install system dependencies
``````````````````````````````
**Ubuntu**
.. code-block:: bash
sudo apt-get -y install doxygen texlive texlive-latex-extra ghostscript pandoc
**macOS**
First, install a TeX distribution such as `MacTeX <http://www.tug.org/mactex/>`_.
.. code-block:: bash
brew install ghostscript pandoc doxygen
2. Install Python dependencies
``````````````````````````````
.. code-block:: bash
pip install -r docs/requirements.txt
Build
-----
First, clone and build Open3D from source and install the Open3D Python package.
Visit :ref:`compilation` for details. After configuration, install the Open3D
Python package with:
.. code-block:: bash
make install-pip-package -j$(nproc)
.. code-block:: bash
cd docs
# Run `python make_docs.py --help` to usage of the flags.
python make_docs.py --help
# Example: build .rst and C++ docs only, skip notebooks.
python make_docs.py --execute_notebooks=never --sphinx --doxygen
# Example: build .rst and C++ docs only, skip notebooks, with parallel build.
python make_docs.py --execute_notebooks=never --sphinx --doxygen --parallel
# Example: build .rst and c++ docs, execute notebooks when it has not been executed.
python make_docs.py --execute_notebooks=auto --sphinx --doxygen
The docs html will be saved in ``docs/_out`` folder.
Preview
-------
Open ``docs/_out/html/index.html`` in a web browser to preview the docs.
.. code-block:: bash
google-chrome docs/_out/html/index.html
|
