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

Add pointers to installing doxygen/sphinx to the build instructions #1346

Merged
merged 1 commit into from
Feb 27, 2023
Merged

Add pointers to installing doxygen/sphinx to the build instructions #1346

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,30 @@ Building the documentation requires that ``sphinx``, ``breathe``, and
<https://github.com/AcademySoftwareFoundation/openexr/blob/main/docs/requirements.txt>`_
file.

See the `doxygen downloads page
<https://www.doxygen.nl/download.html>`_ for how to install it. Binary
distributions are available for many systems, so you likely do not
need to build from source. On Debian/Ubuntu, for example:

.. code-block::

$ sudo apt-get install doxygen

Similarly, see the `sphinx installation page
<https://www.sphinx-doc.org/en/master/usage/installation.html>`_ for
how to install it. On Debian/Ubuntu:

.. code-block::

$ sudo apt-get install python3-sphinx

And to install `sphinx-press-theme
<https://pypi.org/project/sphinx-press-theme>`_:

.. code-block::

$ pip3 install sphinx_press_theme

Note that the `https://openexr.readthedocs.io <https://openexr.readthedocs.io>`_
documentation takes the place of the formerly distributed .pdf
documents in the ``docs`` folder, although readthedocs supports
Expand Down