Publish the documentation to GitHub Pages - #81
Merged
Merged
Conversation
Deploy the Sphinx site to GitHub Pages on pushes to main. The docs job now uploads a Pages artifact and a gated deploy-docs job (push to main only) publishes it via actions/deploy-pages, so the previously build-only docs are served at https://molarverse.github.io/ThermoScreening/. Also set html_baseurl for canonical URLs, add a Documentation project URL and a docs badge, and link the hosted site from the README.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #81 +/- ##
=======================================
Coverage 96.92% 96.92%
=======================================
Files 28 28
Lines 1689 1689
=======================================
Hits 1637 1637
Misses 52 52
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Add a job-level concurrency group so overlapping main pushes queue instead of racing the github-pages environment, and correct the top-level permissions comment.
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
1 participant
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.
What
The Sphinx docs already built in CI but were only uploaded as a throwaway artifact. This publishes them to GitHub Pages at https://molarverse.github.io/ThermoScreening/.
docs.yml: the build job now emits a Pages artifact (actions/upload-pages-artifact), and a newdeploy-docsjob — gated topushonmain— publishes it viaactions/deploy-pageswith the requiredpages: write/id-token: writepermissions and thegithub-pagesenvironment. Pull-request runs still build (catching breakage) but do not deploy.conf.py: sethtml_baseurlfor canonical URLs.pyproject.toml: add aDocumentationproject URL (surfaces on PyPI).README.md: add a docs badge and link the hosted site.Notes
Self-contained — no external service (ReadTheDocs) or account linking. The
alabastertheme ships with Sphinx, so thedocsextra is unchanged. First deploy happens when this merges tomain.