This repository has been archived by the owner on Dec 8, 2024. It is now read-only.
Setup Sphinx documentation #18
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
|
|
Do you get the "sphinx-build not found" error? If so I think you might need |
Yep that worked. I think we may need this Napolean extension for google docstrings? https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html |
|
Looks good, I'll add that in |
MitchellJC
approved these changes
Aug 16, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Sets up Sphinx documentation (with the basic default theme for now) which will be autogenerated from the Python files in the repo, as well as a workflow that publishes it on GitHub pages whenever we push to main.