-
Notifications
You must be signed in to change notification settings - Fork 33
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.
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
Add documentation for generating documentation locally #576
Add documentation for generating documentation locally #576
Conversation
04e6ae4
to
0422fc1
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #576 +/- ##
==========================================
+ Coverage 93.46% 93.55% +0.09%
==========================================
Files 92 92
Lines 6301 6346 +45
==========================================
+ Hits 5889 5937 +48
+ Misses 412 409 -3 see 5 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
(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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
doc/sphinx/developer_manual/contributing_to_the_documentation/building_documentation.md
Outdated
Show resolved
Hide resolved
doc/sphinx/developer_manual/contributing_to_the_documentation/building_documentation.md
Outdated
Show resolved
Hide resolved
doc/sphinx/developer_manual/contributing_to_the_documentation/building_documentation.md
Outdated
Show resolved
Hide resolved
doc/sphinx/developer_manual/contributing_to_the_documentation/building_documentation.md
Show resolved
Hide resolved
Now we compile the GWB normally by running the following: | ||
|
||
:::{code-block} | ||
cmake .. && make |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This step should not be necessary, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes you're right!
0422fc1
to
7206690
Compare
No description provided.