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

Convert build to a Sphinx site and minor updates to docs #80

Merged
merged 1 commit into from
Dec 2, 2021

Conversation

choldgraf
Copy link
Contributor

@choldgraf choldgraf commented Dec 2, 2021

This PR does a few main things:

  • Updates the repository to be a Sphinx site instead of a Jupyter Book. This gives us a bit more control over things and lets us preview the documentation on ReadTheDocs. It retains the same structure and look as if we used Jupyter Book though.
  • Adds links to a few JEPs that were not added to the table of contents when they were accepted.
  • Adds numbering to these JEPs to make them more in-line with our other JEPs
  • Adds the current active JEP in Jupyter Notebook version 7 #79 to our README
  • Adds instructions to our README for how to build the docs locally
  • Adds a noxfile.py so that we can automate building docs via nox
  • Removes the CircleCI build, since we are now building the docs with ReadTheDocs previews

We can now preview the built docs in PRs, like so: https://jupyter-enhancement-proposals--80.org.readthedocs.build/en/80/README.html

@choldgraf choldgraf changed the title Convert build to a Sphinx site Convert build to a Sphinx site and minor updates to docs Dec 2, 2021
Copy link
Contributor

@blink1073 blink1073 left a comment

Choose a reason for hiding this comment

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

Thanks!

@blink1073
Copy link
Contributor

Merging since this is an admin-only change.

@choldgraf
Copy link
Contributor Author

(we can disable docs builds on CircleCI if this gets merged, though I do not have permissions to do so)

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.

2 participants