-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #576 from danieldouglas92/generate_manual_doc
Add documentation for generating documentation locally
- Loading branch information
Showing
2 changed files
with
26 additions
and
0 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
...nx/developer_manual/contributing_to_the_documentation/building_documentation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters