Skip to content

Commit

Permalink
Small fixes for instrucitons on how to build docs locally
Browse files Browse the repository at this point in the history
  • Loading branch information
ksbeattie committed Feb 12, 2025
1 parent d43c5dd commit acf76d6
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/reference_guides/developer/howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Developer environment
---------------------
Development of IDAES will require an extra set of required package not needed by regular users.
To install those extra developer tools use the command ``pip install -r requirements-dev.txt``
rather than ``pip install -r requirements.txt``
rather than ``pip install -e .``


Code style
Expand Down Expand Up @@ -142,23 +142,23 @@ Documentation
The documentation is built from its sources with a tool called Sphinx.
The sources for the documentation are:

* hand-written text files, under `docs/`, with the extension ".rst" for `reStructuredText`_.
* hand-written text files, under ``docs/``, with the extension ".rst" for `reStructuredText`_.
* the Python source code
* selected Jupyter Notebooks

Building documentation
^^^^^^^^^^^^^^^^^^^^^^

.. note:: To build the documentation locally, you will need to have the Sphinx tools installed.
This will be done for you by running ``pip install requirements-dev.txt`` ("developer" setup)
as opposed to the regular ``pip install requirements.txt`` ("user" setup).
This will be done for you by running ``pip install -r requirements-dev.txt`` ("developer" setup)
as opposed to the regular ``pip install -e .`` ("user" setup).

To build the documentation locally, use our custom `build.py` script.
To build the documentation locally, use our custom ``build.py`` script::

cd docs
python build.py
python build.py [--dirty]

The above commands will do a completely clean build to create HTML output.
The above commands will do a completely clean build (unless the ``--dirty`` option is used) to create HTML output.

If the command succeeds, the final line will look like::

Expand Down

0 comments on commit acf76d6

Please sign in to comment.