Add readthedocs and sphinx to cladetime #35
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is cladetime's MVP documentation. Most of the changes are in the docs/ folder which contains readthedocs and sphinx configuration, as well as the documentation pages written in restructured text. Out of scope: hosting on GitHub pages, CI/CD publishing and previews. The goal of this change is to give early users enough information to get started.
elray1
requested changes
Oct 16, 2024
Co-authored-by: Evan Ray <[email protected]>
Co-authored-by: Evan Ray <[email protected]>
Co-authored-by: Evan Ray <[email protected]>
Co-authored-by: Evan Ray <[email protected]>
Co-authored-by: Evan Ray <[email protected]>
Co-authored-by: Evan Ray <[email protected]>
Co-authored-by: Evan Ray <[email protected]>
Thanks for the close read @elray1--I'll try to ingrain the correct capitalization of |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #30
This is cladetime's MVP documentation. Most of the changes are in the docs/ folder which contains readthedocs and sphinx configuration, as well as the documentation pages written in restructured text.
Out of scope: hosting on GitHub pages, CI/CD publishing and previews. The goal of this change is to give early users enough information to get started.
The docs are currently hosted on readthedocs and can be viewed here: https://cladetime.readthedocs.io/en/latest/index.html
The link above has been added to the repo's description for easier reference.