Closed NoraLoose closed 1 month ago
Check out this pull request on
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
@dafyddstephenson does either 1. or 2. in my notes above raise any red flags for you?
@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.
There is still some work to do for future PRs (I will document these in issues), but this is good to merge for now.
This PR sets up a sphinx-based documentation that supports both markdown / MyST and ReStructuredText (RST).
Notes
movedcopied the notebookcstar_example_notebook.ipynb
from theexamples
directory to thedocs
directory so that we can include that notebook in the documentation. (It can't sit outside thedocs
directory.) I removed the uppermost markdown cell with the caption "Installation" from the notebook becauseci/environment.yml
so that we can test the documentation build as part of the CIStill to do in future PRs
pre-commit
, so I suggest addingpre-commit
to the CI andcstar_env
. (I'm happy to do this in a follow-up PR).pytest
because that's what the Contributor Guide (docs/contributing.md
) promises.