From 7206690101ffd431716042e3424217772886d571 Mon Sep 17 00:00:00 2001 From: danieldouglas92 Date: Tue, 13 Feb 2024 23:14:53 -0600 Subject: [PATCH] Add documentation --- .../building_documentation.md | 25 +++++++++++++++++++ .../index.md | 1 + 2 files changed, 26 insertions(+) create mode 100644 doc/sphinx/developer_manual/contributing_to_the_documentation/building_documentation.md diff --git a/doc/sphinx/developer_manual/contributing_to_the_documentation/building_documentation.md b/doc/sphinx/developer_manual/contributing_to_the_documentation/building_documentation.md new file mode 100644 index 000000000..30d31dbae --- /dev/null +++ b/doc/sphinx/developer_manual/contributing_to_the_documentation/building_documentation.md @@ -0,0 +1,25 @@ +(part:dev_manual:chap:contribute_to_doc:sec:building_doc)= +Building documentation +========================= + +To build the documentation locally, you first need to ensure you have the right Python packages installed. The list of packages required to build the documentation is located in `$WORLD_BUILDER_SOURCE_DIR/doc/requirements.txt`, and can be installed using + +:::{code-block} +pip install -r $WORLD_BUILDER_SOURCE_DIR/doc/requirements.txt +::: + +Now that the Python packages are installed, we need to toggle the option in cmake to build the target for the GWB documention, this can be done using the interactive GUI `ccmake` and enabling `WB_BUILD_DOCUMENTATION` or by running the following command: + +:::{code-block} +cd $WORLD_BUILDER_SOURCE_DIR/build \\ +cmake -D WB_BUILD_DOCUMENTATION=ON . +::: + +This adds the target for the documentation in `$WORLD_BUILDER_SOURCE_DIR/build/doc`, to finish building the documentation run the final commands: + +:::{code-block} +cd $WORLD_BUILDER_SOURCE_DIR/build/doc \\ +make manual +::: + +This compiles the sphinx documentation, which will be built in `$WORLD_BUILDER_SOURCE_DIR/build/doc/sphinx`. diff --git a/doc/sphinx/developer_manual/contributing_to_the_documentation/index.md b/doc/sphinx/developer_manual/contributing_to_the_documentation/index.md index bdd32bbb0..3743024c2 100644 --- a/doc/sphinx/developer_manual/contributing_to_the_documentation/index.md +++ b/doc/sphinx/developer_manual/contributing_to_the_documentation/index.md @@ -9,6 +9,7 @@ The documentation is very important and it is also a good way to learn git and t ```{toctree} :hidden: +building_documentation important_syntax documentation_style_guide documentation_testing