From ac5b6c49696216047a2174c611b5c48282fbf9fb Mon Sep 17 00:00:00 2001 From: Marc Henry de Frahan Date: Wed, 25 Sep 2024 10:21:40 -0600 Subject: [PATCH 1/3] Update documentation building instructions --- docs/sphinx/source/developer/build_doc.rst | 29 +++++-------------- .../sphinx/source/user/do-config-nalu-wind.sh | 1 - 2 files changed, 7 insertions(+), 23 deletions(-) diff --git a/docs/sphinx/source/developer/build_doc.rst b/docs/sphinx/source/developer/build_doc.rst index d7a593ae98..48d89cd6b9 100644 --- a/docs/sphinx/source/developer/build_doc.rst +++ b/docs/sphinx/source/developer/build_doc.rst @@ -31,30 +31,15 @@ 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 `__ 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 `__ 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 -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``. diff --git a/docs/sphinx/source/user/do-config-nalu-wind.sh b/docs/sphinx/source/user/do-config-nalu-wind.sh index 051b129612..65f672b73b 100644 --- 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 \ ..) From be52f228e505c87215b32e69126b4421187c409b Mon Sep 17 00:00:00 2001 From: Marc Henry de Frahan Date: Wed, 25 Sep 2024 10:22:55 -0600 Subject: [PATCH 2/3] Add doxygen --- docs/sphinx/source/developer/build_doc.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sphinx/source/developer/build_doc.rst b/docs/sphinx/source/developer/build_doc.rst index 48d89cd6b9..e404f14a3f 100644 --- a/docs/sphinx/source/developer/build_doc.rst +++ b/docs/sphinx/source/developer/build_doc.rst @@ -39,6 +39,7 @@ In the `Nalu-Wind repository `__ checkout, :: 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, the command will complete successfully and the entry point to the documentation should From 6b502f089a6f17a1a0448dde1d07cef6796f1655 Mon Sep 17 00:00:00 2001 From: Marc Henry de Frahan Date: Wed, 25 Sep 2024 10:24:41 -0600 Subject: [PATCH 3/3] tweak --- docs/sphinx/source/developer/build_doc.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/developer/build_doc.rst b/docs/sphinx/source/developer/build_doc.rst index e404f14a3f..3abef16d48 100644 --- a/docs/sphinx/source/developer/build_doc.rst +++ b/docs/sphinx/source/developer/build_doc.rst @@ -43,4 +43,5 @@ In the `Nalu-Wind repository `__ checkout, 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``. +be in ``build_docs/manual/html/index.html`` for the manual and +``build_docs/doxygen/html/index.html`` for the source code.