Reorganize documentation into Sphinx #1374
Closed
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
|
@Sparkier just realized I missed your PR because I started implementing this earlier. Do you have any strong opinions? I lean towards Sphinx to automatically generate code documentation from Python docstrings, and for integration w/ Python tooling in general. |
|
Hey, I started a slack thread since this is a bigger decision. Hope that's ok with you. |
|
Closing in favor of #1372 |
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.
Currently, we have all documentation in a
docs/directory. This PR moves the documents into Sphinx to generate a documentation website, which has several advantages:We can host this on GitHub Pages or ReadTheDocs.