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

Update doc build instructions #1312

Merged
merged 4 commits into from
Sep 30, 2024
Merged

Update doc build instructions #1312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ac5b6c4
Update documentation building instructions
marchdf Sep 25, 2024
be52f22
Add doxygen
marchdf Sep 25, 2024
6b502f0
tweak
marchdf Sep 25, 2024
84f69c3
Merge branch 'master' into update-doc-build
jrood-nrel Sep 30, 2024
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
31 changes: 9 additions & 22 deletions docs/sphinx/source/developer/build_doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,30 +31,17 @@ this would look something like:
On Linux, CMake, Python, Doxygen, and GraphViz could be installed
using your package manager, e.g. ``sudo apt-get install cmake``.

Run CMake Configure
-------------------
Build the Docs
--------------

In the `Nalu-Wind repository <https://github.com/Exawind/nalu-wind>`__ checkout,
create your own or use the ``build`` directory that already exists in the repo.
Change to your designated build directory and run CMake with ``-DENABLE_DOCUMENTATION``
on. For example:
In the `Nalu-Wind repository <https://github.com/Exawind/nalu-wind>`__ checkout, execute:

::

cmake -DTrilinos_DIR:PATH=$(spack location -i nalu-trilinos) \
-DYAML_DIR:PATH=$(spack location -i yaml-cpp) \
-DCMAKE_BUILD_TYPE=RELEASE \
-DENABLE_DOCUMENTATION:BOOL=ON \
..
sphinx-build -M html ./docs/sphinx ./build_docs/manual -W --keep-going -n
doxygen ./docs/doxygen/Doxyfile

If all of the main tools are found successfully, CMake should configure with the ability
to build the documentation. If Sphinx or Doxygen aren't found, the configure will skip
the documentation.

Make the Docs
-------------

In your designated build directory, issue the command ``make docs`` which
should first build the Doxygen documentation and then the Sphinx documentation.
If this completes successfully, the entry point to
the documentation should be in ``build/docs/html/index.html``.
If all of the main tools are found successfully, the command will
complete successfully and the entry point to the documentation should
be in ``build_docs/manual/html/index.html`` for the manual and
``build_docs/doxygen/html/index.html`` for the source code.
1 change: 0 additions & 1 deletion docs/sphinx/source/user/do-config-nalu-wind.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ set -e
-DTrilinos_DIR:PATH=${TRILINOS_ROOT_DIR} \
-DYAML_DIR:PATH=${YAML_CPP_ROOT_DIR} \
-DCMAKE_BUILD_TYPE:STRING=RELEASE \
-DENABLE_DOCUMENTATION:BOOL=OFF \
-DENABLE_TESTS:BOOL=ON \
..)

Expand Down
Loading