Update doc build instructions (#1312)

* Update documentation building instructions * Add doxygen * tweak --------- Co-authored-by: Jon Rood <[email protected]>
Exawind · Sep 30, 2024 · 157ef74 · 157ef74
1 parent f3cecaf
commit 157ef74
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 23 deletions.
diff --git a/docs/sphinx/source/developer/build_doc.rst b/docs/sphinx/source/developer/build_doc.rst
@@ -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.
diff --git a/docs/sphinx/source/user/do-config-nalu-wind.sh b/docs/sphinx/source/user/do-config-nalu-wind.sh
@@ -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 \
   ..)