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.

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

Merged

Conversation

danieldouglas92
Copy link
Contributor

No description provided.

@danieldouglas92 danieldouglas92 force-pushed the generate_manual_doc branch 2 times, most recently from 04e6ae4 to 0422fc1 Compare February 14, 2024 05:16
Copy link

codecov bot commented Feb 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (40655ff) 93.46% compared to head (7206690) 93.55%.
Report is 82 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 40655ff...7206690. Read the comment docs.

Copy link

github-actions bot commented Feb 14, 2024

Benchmark Main Feature Difference (99.9% CI)
Slab interpolation simple none 1.027 ± 0.008 (s=448) 1.026 ± 0.009 (s=431) -0.2% .. +0.2%
Slab interpolation curved simple none 1.028 ± 0.004 (s=451) 1.028 ± 0.003 (s=427) -0.1% .. +0.1%
Spherical slab interpolation simple none 1.264 ± 0.006 (s=339) 1.263 ± 0.005 (s=376) -0.2% .. +0.0%
Slab interpolation simple curved CMS 1.102 ± 0.004 (s=409) 1.101 ± 0.003 (s=410) -0.2% .. -0.0%
Spherical slab interpolation simple CMS 1.864 ± 0.008 (s=272) 1.868 ± 0.006 (s=213) +0.1% .. +0.3%
Spherical fault interpolation simple none 1.274 ± 0.010 (s=361) 1.275 ± 0.004 (s=347) -0.1% .. +0.2%
Cartesian min max surface 2.381 ± 0.015 (s=202) 2.381 ± 0.017 (s=179) -0.2% .. +0.2%
Spherical min max surface 7.358 ± 0.020 (s=80) 7.355 ± 0.038 (s=45) -0.3% .. +0.2%

Copy link
Contributor

@tjhei tjhei left a 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Now we compile the GWB normally by running the following:

:::{code-block}
cmake .. && make
Copy link
Contributor

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you're right!

@MFraters MFraters merged commit 597cfa7 into GeodynamicWorldBuilder:main Feb 14, 2024
33 of 34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants