Skip to content

Bootstrapping GitHub Pages#62

Open
sdunnack wants to merge 1 commit intomainfrom
dunnack/sphinx-to-github-pages
Open

Bootstrapping GitHub Pages#62
sdunnack wants to merge 1 commit intomainfrom
dunnack/sphinx-to-github-pages

Conversation

@sdunnack
Copy link

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:

  • Added a new GitHub Actions workflow (.github/workflows/gh-pages.yaml) to deploy Sphinx documentation to GitHub Pages. The workflow triggers on pushes to the main branch or the dunnack/sphinx-to-github-pages branch and includes steps to check out the repository and deploy using the sphinx-notes/pages action.

Dependency Updates:

  • Updated sphinx-autodoc-typehints to version 3.2.0 and sphinx_rtd_theme to version 3.0.2 in docs/requirements.txt. Additionally, updated m2r to version 0.3.1 and commented out sphinx-autobuild and sphinx dependencies, likely to address compatibility or deprecation issues.

@mjs2600
Copy link
Contributor

mjs2600 commented Jan 16, 2026

@sdunnack should we merge this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants