CWorthy-ocean / C-Star

C-Star is a python package for setting up and running ocean model simulations, with a particular focus on marine carbon dioxide removal (mCDR) applications.
https://c-star.readthedocs.io
10 stars 4 forks source link

Setting up the documentation #60

Closed NoraLoose closed 1 month ago

NoraLoose commented 1 month ago

This PR sets up a sphinx-based documentation that supports both markdown / MyST and ReStructuredText (RST).

Notes

  1. I moved copied the notebook cstar_example_notebook.ipynb from the examples directory to the docs directory so that we can include that notebook in the documentation. (It can't sit outside the docs directory.) I removed the uppermost markdown cell with the caption "Installation" from the notebook because
    • we have a separate installation section in the docs
    • both "Installation" and "Introduction to C-Star “v0” with the roms_marbl_example Case" are top-level headings ("#"), but sphinx wants there only to be one top-level heading, otherwise the formatting is off
  2. I added the sphinx-based dependencies to ci/environment.yml so that we can test the documentation build as part of the CI
  3. I added a test that builds the documentation to the GitHub workflows

Still to do in future PRs

review-notebook-app[bot] commented 1 month ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

NoraLoose commented 1 month ago

@dafyddstephenson does either 1. or 2. in my notes above raise any red flags for you?

NoraLoose commented 1 month ago

@dafyddstephenson does either 1. or 2. in my notes above raise any red flags for you?

If not, I suggest to merge so that I can test whether RTD can successfully deploy the documentation.

NoraLoose commented 1 month ago

There is still some work to do for future PRs (I will document these in issues), but this is good to merge for now.