Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement automatic HTML generation #49

Closed
wants to merge 1 commit into from
Closed

Implement automatic HTML generation #49

wants to merge 1 commit into from

Commits on Mar 12, 2024

  1. Implement automatic HTML generation 

    Add automation via GitHub Actions to generate the specification HTML and
deploy the same to GitHub Pages.

Additionally, rework HTML generation to use Poetry¹ to set up and manage
a virtual environment used to generate the HTML. This helps ensure that
both local and automated builds are using a uniform environment.

Note that deployment eschews the `upload-pages-artifact`² action because
the mechanism used here allows us to bundle the files and correct their
permissions in one command.

For clarity, the `_ext` directory is renamed to `_extensions`. Also, the
minimum Sphinx version is bumped to 6.2, as that's what's been in use
recently and Poetry allows us to be less "stuck" on what's provided by
distributions.

¹ https://python-poetry.org/
² https://github.com/actions/upload-pages-artifact/

Fixes #40.

Co-authored-by: Matthew Woehlke <[email protected]>
    @bruxisma @mwoehlke
    bruxisma and mwoehlke committed Mar 12, 2024
    Configuration menu
    Copy the full SHA
    0c62006 View commit details
    Browse the repository at this point in the history