Skip to content

Clean up Sphinx docs workflow#218

Merged
riley-harper merged 3 commits intomainfrom
docs-cleanup
Apr 29, 2025
Merged

Clean up Sphinx docs workflow#218
riley-harper merged 3 commits intomainfrom
docs-cleanup

Conversation

@riley-harper
Copy link
Copy Markdown
Contributor

@riley-harper riley-harper commented Apr 28, 2025

Now that we are automatically generating the Sphinx docs on pushes to main, we can clean up the previous workflow by

  • Removing the docs/ directory.
  • Updating doc/developer.md with the new workflow instructions.
  • Updating the sphinx-docs/Makefile so that it doesn't copy the build files to docs/.
  • Pinning Sphinx and Recommonmark less closely in pyproject.toml.

This closes #128.

@riley-harper riley-harper requested a review from joegrover April 28, 2025 20:08
We no longer need to regenerate the Sphinx docs when making a new
version.
Copy link
Copy Markdown
Contributor

@joegrover joegrover left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@riley-harper riley-harper merged commit 9bd3a50 into main Apr 29, 2025
6 checks passed
@riley-harper riley-harper deleted the docs-cleanup branch April 29, 2025 14:05
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.

Generate Sphinx docs via Github Actions

2 participants