Open
Conversation
Contributor
|
@sdunnack should we merge this? |
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
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.
Ticket
TOOLSMITHS-2175
Description
This pull request introduces a workflow to deploy Sphinx documentation to GitHub Pages and updates the Sphinx-related dependencies in
docs/requirements.txt. These changes aim to automate documentation deployment and modernize the Sphinx toolchain.Deployment Workflow:
.github/workflows/gh-pages.yaml) to deploy Sphinx documentation to GitHub Pages. The workflow triggers on pushes to themainbranch or thedunnack/sphinx-to-github-pagesbranch and includes steps to check out the repository and deploy using thesphinx-notes/pagesaction.Dependency Updates:
sphinx-autodoc-typehintsto version3.2.0andsphinx_rtd_themeto version3.0.2indocs/requirements.txt. Additionally, updatedm2rto version0.3.1and commented outsphinx-autobuildandsphinxdependencies, likely to address compatibility or deprecation issues.