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

migrate to readthedocs documentation #311

Merged
merged 11 commits into from
Nov 16, 2022
Merged

migrate to readthedocs documentation #311

merged 11 commits into from
Nov 16, 2022

Conversation

dlqqq
Copy link
Collaborator

@dlqqq dlqqq commented Nov 15, 2022

Begins the process of migrating to ReadTheDocs as our documentation.

  • Sets up Sphinx documentation generator boilerplate
  • Migrates documentation away from README.md and RELEASE.md
  • Adds documentation on writing documentation and using Jupyter Releaser under the contributor's guide

Closes #310.

@dlqqq dlqqq added the documentation Improvements or additions to documentation label Nov 15, 2022
@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch dlqqq/jupyter-scheduler/docs

@dlqqq
Copy link
Collaborator Author

dlqqq commented Nov 15, 2022

kicking CI

@dlqqq dlqqq closed this Nov 15, 2022
@dlqqq dlqqq reopened this Nov 15, 2022
@dlqqq dlqqq closed this Nov 15, 2022
@dlqqq dlqqq reopened this Nov 15, 2022
@dlqqq
Copy link
Collaborator Author

dlqqq commented Nov 15, 2022

We'll need a follow-up PR to add links to the documentation in the README. Not adding them yet because 404 links in README will cause a CI failure, if memory serves.

@dlqqq
Copy link
Collaborator Author

dlqqq commented Nov 15, 2022

BTW, you can view the docs preview for a PR by clicking "View details" on the readthedocs CI job.

docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/operators/index.md Outdated Show resolved Hide resolved
docs/operators/index.md Outdated Show resolved Hide resolved
docs/users/index.md Outdated Show resolved Hide resolved
docs/users/index.md Show resolved Hide resolved
docs/users/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/contributors/index.md Outdated Show resolved Hide resolved
docs/operators/index.md Outdated Show resolved Hide resolved
docs/users/index.md Outdated Show resolved Hide resolved
docs/users/index.md Outdated Show resolved Hide resolved
Additional small copy edits
@dlqqq dlqqq merged commit 32a370a into jupyter-server:main Nov 16, 2022
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.

3 participants