Skip to content

Commit

Permalink
Merge pull request #2934 from jessica-mitchell/update-cmake-options
Browse files Browse the repository at this point in the history
Add documentation builds to cmake options
  • Loading branch information
jessica-mitchell authored Sep 12, 2023
2 parents fddb5ff + 4273d87 commit f565c96
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
20 changes: 19 additions & 1 deletion doc/htmldoc/installation/cmake_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ environment.

.. note::

If you want to specify an alternative install location, use
If you want to specify an alternative install location, use
``-DCMAKE_INSTALL_PREFIX:PATH=<nest_install_dir>``. It needs to be
writable by the user running the install command.

Expand Down Expand Up @@ -89,6 +89,24 @@ Select parallelization scheme

See also the section on :ref:`building with MPI <compile-with-mpi>` below.


Build documentation
~~~~~~~~~~~~~~~~~~~

+------------------------------+-------------------------------------------------------------+
| ``-Dwith-devdoc=[OFF|ON]`` | Build the developer (doxygen) documentation [default=OFF] |
| | |
+------------------------------+-------------------------------------------------------------+
| ``-Dwith-userdoc=[OFF|ON]`` | Build the user (Sphinx) documentation [default=OFF] |
| | |
+------------------------------+-------------------------------------------------------------+

If either documentation build is toggled to `ON`, you can then run ``make docs`` if you only want to
build the docs.

See also the :ref:`documentation workflow <doc_workflow>` for user and developer docs.


External libraries
~~~~~~~~~~~~~~~~~~

Expand Down
5 changes: 5 additions & 0 deletions doc/htmldoc/installation/developer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ file that contains all possible packages needed for NEST development.

If you want to install NEST without any environment, see the :ref:`instructions here <noenv>`.


.. seealso::

:ref:`cmake options for NEST <cmake_options>`

What gets installed where
-------------------------

Expand Down

0 comments on commit f565c96

Please sign in to comment.