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 instructions to run tests + build docs locally #44

Merged
merged 10 commits into from
Jun 22, 2023

Conversation

navidcy
Copy link
Contributor

@navidcy navidcy commented Jun 18, 2023

This PR adds a section in the docs to explain how contributors can:

  • run the tests locally
  • build and preview the docs locally

https://mom6-regional--44.org.readthedocs.build/en/44/contributing.html

@navidcy navidcy added the documentation 📔 Improvements or additions to documentation label Jun 18, 2023
@navidcy navidcy requested a review from angus-g June 18, 2023 06:59
@navidcy navidcy mentioned this pull request Jun 18, 2023
@codecov
Copy link

codecov bot commented Jun 18, 2023

Codecov Report

Merging #44 (5257230) into main (91fcc59) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #44   +/-   ##
=======================================
  Coverage   10.72%   10.72%           
=======================================
  Files           2        2           
  Lines         429      429           
=======================================
  Hits           46       46           
  Misses        383      383           

@navidcy
Copy link
Contributor Author

navidcy commented Jun 18, 2023

I admit I didn't try the pip version. But the conda version worked for me!

@navidcy navidcy requested a review from ashjbarnes June 18, 2023 07:09
@navidcy navidcy changed the title Add instructions to build docs Add instructions to run tests + build docs locally Jun 19, 2023
@navidcy navidcy merged commit 1ac6e85 into main Jun 22, 2023
@navidcy navidcy deleted the ncc/add-instructions-to-build-docs branch June 22, 2023 04:21

```{code-block} bash
cd docs
pip install -r docs/requirements.txt
Copy link
Collaborator

Choose a reason for hiding this comment

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

This won't work, would be just pip install -r requirements.txt since you changed into docs in the previous line.

@navidcy
Copy link
Contributor Author

navidcy commented Jun 22, 2023

I'll fix it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📔 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants