Skip to content

Commit

Permalink
Update building_documentation.md
Browse files Browse the repository at this point in the history
Minor cosmetic changes.
  • Loading branch information
ljhwang authored Jun 1, 2024
1 parent a126f51 commit 34d1093
Showing 1 changed file with 4 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
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
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
Expand All @@ -15,7 +15,9 @@ 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:
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 \\
Expand Down

0 comments on commit 34d1093

Please sign in to comment.