Automatically generate API docs from a Spyder repo submodule #12
Conversation
This file contains hidden or 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
✅ Deploy Preview for spyder-api-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
CAM-Gerlach
force-pushed
the
add-autodocstring-build
branch
3 times, most recently
from
c527172 to
de43279
Compare
CAM-Gerlach
force-pushed
the
add-autodocstring-build
branch
2 times, most recently
from
8dba112 to
150866c
Compare
CAM-Gerlach
force-pushed
the
add-autodocstring-build
branch
from
150866c to
e33bf93
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Pull Request
Pull Request Checklist
Description of Changes
Adds the Spyder repo as a submodule, sets up the infra to generate API docs from it using Sphinx-Autosummary, and adds a bunch of new Nox commands and CONTRIBUTING guide instructions to take advantage of it.
Might need some pre-commit fixes as its been some time since the hooks have been updated.Done, also did some further rebasing and cleanup.EDIT: Also added separate GitHub Actions jobs for builds with and without the autodoc generation, to verify that both work properly, isolate any issues and check our own docs here with warnings and broken references treated as errors, while not failing (yet) on such in docstrings.