feat(docs): add autogenerated sphinx docs to github pages #676
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
dines-rl
reviewed
Nov 19, 2025
.github/workflows/sphinx.yml
Outdated
| @@ -0,0 +1,33 @@ | |||
| name: "Sphinx: Render docs" | |||
|
|
|||
| on: push | |||
Contributor
There was a problem hiding this comment.
I think we want on release as it is in the other PR otherwise our preview will get pushed to the live version, also the ability to trigger the action manually
dines-rl
approved these changes
Nov 19, 2025
…n push. also added workflow_dispatch trigger
sid-rl
added a commit
that referenced
this pull request
Nov 19, 2025
* initial sphinx docstring conversion * change params to use :typeddict: tag * sphinx docs * sphinx github workflow * formatting fixes * fix publish dir * unnecessary argument to sphinx action * switch to manual build html command instead of ammaraskar/sphinx-action * sphinx docs rendering is triggered on published release, instead of on push. also added workflow_dispatch trigger
sid-rl
added a commit
that referenced
this pull request
Nov 19, 2025
* initial sphinx docstring conversion * change params to use :typeddict: tag * sphinx docs * sphinx github workflow * formatting fixes * fix publish dir * unnecessary argument to sphinx action * switch to manual build html command instead of ammaraskar/sphinx-action * sphinx docs rendering is triggered on published release, instead of on push. also added workflow_dispatch trigger
sid-rl
added a commit
that referenced
this pull request
Nov 20, 2025
…ith sphinx (#677) * ignore generated docs files * feat(docs): add autogenerated sphinx docs to github pages (#676) * initial sphinx docstring conversion * change params to use :typeddict: tag * sphinx docs * sphinx github workflow * formatting fixes * fix publish dir * unnecessary argument to sphinx action * switch to manual build html command instead of ammaraskar/sphinx-action * sphinx docs rendering is triggered on published release, instead of on push. also added workflow_dispatch trigger * remove merge conflict marker
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.
No description provided.