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

Build API docs #38

Merged
merged 5 commits into from
Jun 15, 2023
Merged

Build API docs #38

merged 5 commits into from
Jun 15, 2023

Conversation

angus-g
Copy link
Collaborator

@angus-g angus-g commented Jun 15, 2023

The page for the moment needs a decent bit of work for prettiness, but it's doing automatic API documentation. I will add the demo notebook as its own built page. This uses MyST so it should allow for standalone Markdown pages, rather than rST. Docs should be building on RTD from now too.

@navidcy navidcy added the documentation 📔 Improvements or additions to documentation label Jun 15, 2023
@navidcy navidcy self-requested a review June 15, 2023 01:21
@codecov
Copy link

codecov bot commented Jun 15, 2023

Codecov Report

Merging #38 (f522ab0) into main (145e9f2) will not change coverage.
The diff coverage is 50.00%.

❗ Current head f522ab0 differs from pull request most recent head 0991909. Consider uploading reports for the commit 0991909 to get more accurate results

@@          Coverage Diff          @@
##            main     #38   +/-   ##
=====================================
  Coverage   8.81%   8.81%           
=====================================
  Files          2       2           
  Lines        431     431           
=====================================
  Hits          38      38           
  Misses       393     393           
Impacted Files Coverage Δ
mom6_regional/mom6_regional.py 8.21% <50.00%> (ø)

Copy link
Contributor

@navidcy navidcy left a comment

Choose a reason for hiding this comment

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

This looks great!

Can we add a docs badge at the README.md that points to the documentation?

@navidcy
Copy link
Contributor

navidcy commented Jun 15, 2023

merge?

@angus-g angus-g merged commit f7ad32b into main Jun 15, 2023
@angus-g angus-g deleted the angus-g/docs branch June 15, 2023 01:53
@navidcy navidcy mentioned this pull request Jun 15, 2023
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.

2 participants