Repository navigation
Deploy the docs with the GitHub Pages actions so the site is current again - #187
Merged
Merged
Conversation
The Pages source of the repository is "GitHub Actions", so pushing the built HTML to the gh-pages branch does not publish it: the site has stayed at the build of 19 March 2026 (0.10.0), while every push to master since has still built the docs and pushed them to gh-pages. On a push to master the workflow now uploads the built HTML with actions/upload-pages-artifact and deploys it with actions/deploy-pages; the github-pages environment already lets master deploy. The build needs only read access now, and checkout and setup-python move to versions that run on Node 24, which the runners force on the Node 20 actions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
conf.py took the release from the metadata of the installed ledsa, which an editable install keeps from the time it was installed: a local build showed 0.10.0 for the 0.13.0 source. It now reads the pyproject.toml of the source tree it documents, and falls back to the installed metadata on Python older than 3.11, which lacks tomllib. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The CLI page named -s1 as --s1 and the acceptance test options --acceptance-test instead of --acceptance_test, and two literals that lacked a backtick rendered as one, "--step_3`, ``--analyse_photo". --setup needs a path rather than defaulting to ".", and --color_correction and the --n_cores of the demo were missing. Every option the page names now exists in the parser. The installation page gets the supported Python versions and the steps to install from a clone, as in the README. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Why the site is outdated
https://firedynamics.github.io/LEDSmokeAnalysis/ still serves the build of 19 March 2026 (release 0.10.0). The Pages source of the repository (Settings → Pages) is GitHub Actions (
build_type: workflowin the Pages API), but the Docs workflow pushes the built HTML to thegh-pagesbranch, which Pages only publishes when the source is "Deploy from a branch". The lastpages-build-deploymentrun was on 19 March. Every push to master since, the latest on 10 November, built the docs and pushed a correct 0.13.0 build togh-pagesthat was never published.What changed
.github/workflows/build_documentation.yaml: on a push to master, the build job uploads_build/withactions/upload-pages-artifact@v5, and a newdeployjob publishes it withactions/deploy-pages@v5(environmentgithub-pages, one deployment at a time). Branches and pull requests still only build. The workflow needscontents: readinstead ofcontents: write.checkoutandsetup-pythonmove to v7, which run on Node 24, so the "Node.js 20 is deprecated" warning goes away. The build job is renamed fromdocstobuild; master has no branch protection or ruleset that requires the old check name.doc/conf.py: the release comes frompyproject.tomlinstead of the metadata of the installedledsa, which an editable install keeps from when it was installed (locally it reported 0.10.0 for the 0.13.0 source). Python older than 3.11 has notomlliband falls back to the metadata.doc/cli_documentation.rst:--s1→-s1, and--acceptance-test[_debug]→--acceptance_test[_debug].--step_3and--step_3_fastlacked their closing backticks and ran into the option after them in one literal; they now render separately.--setup PATHneeds a path rather than defaulting to..--color_correctionand the--n_coresof the demo were missing.doc/installation.rst: the supported Python versions (3.9 to 3.12) and the steps to install from a clone, as in the README.Testing
sphinx-build -W --keep-going doc _buildbuilds without warnings, and the page title and index page show 0.13.0.ledsa.core.parser_arguments_declaration.check-jsonschema --builtin-schema vendor.github-workflows), and the deploy job matches the usage in theactions/deploy-pagesREADME.github-pagesenvironment already allowsmasterto deploy.After merging
deployjob that links to the site, which should then show 0.13.0.gh-pagesany more, so that branch can be deleted.pip install ledsagives an older version than the docs describe until 0.13.0 is released.🤖 Generated with Claude Code