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

140 add nbs to readthedocs #165

Merged
merged 10 commits into from
Aug 29, 2024
Merged

140 add nbs to readthedocs #165

merged 10 commits into from
Aug 29, 2024

Conversation

jrob93
Copy link
Collaborator

@jrob93 jrob93 commented Aug 29, 2024

Fixes #140 .

I think I've figured out how to add example notebooks to the read the docs.

  • Copy notebook into docs/notebooks (N.B. the notebook must have at least one section header)
  • Update the toctree in the file docs/notebooks.rst
  • To update the docs locally, from the docs dir run: python -m sphinx -T -E -b html -d _build/doctrees -D language=en . ../_readthedocs/html

I want to push this into main to see if the online read the docs is updated automatically.

Review Checklist for Source Code Changes

  • Does pip install still work?
  • Have you written a unit test for any new functions?
  • Do all the units tests run successfully?
  • Does adler run successfully on a test set of input files/databases?
  • Have you used black on the files you have updated to confirm python programming style guide enforcement?

@jrob93 jrob93 requested a review from astronomerritt August 29, 2024 11:28
@jrob93 jrob93 linked an issue Aug 29, 2024 that may be closed by this pull request
@jrob93
Copy link
Collaborator Author

jrob93 commented Aug 29, 2024

Had to update some requirements (scipy). Also, make sure that the notebook being added to the docs is using the python3 (ipykernel) kernel, not some conda env kernel that may only be installed locally

@jrob93 jrob93 merged commit 4332bde into main Aug 29, 2024
10 checks passed
@jrob93 jrob93 deleted the 140-add-nbs-to-readthedocs branch August 30, 2024 09:30
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.

add nbs to readthedocs
2 participants