Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update building_documentation.md #733

Merged
merged 1 commit into from
Jun 2, 2024
Merged

Update building_documentation.md #733

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ...nx/developer_manual/contributing_to_the_documentation/building_documentation.md
View file
Open in desktop
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
Loading