ci: fix broken doc build & update GitHub Actions versions #117
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.
Context
As @arokem said in #116, doc build in CI is currently broken.
What's included
The new CI runs without errors: documentation build works (all unit tests still pass).
Changes include:
checkout
,setup-python
,upload-artifact
)ACCESS_TOKEN
withGITHUB_TOKEN
pip install .
sphinx.ext.githubpages
Sphinx built-in extension, to ensure_static/
files (e.g. CSS) are properly served on GitHub Page (1)index.rst
that caused HTML malformation (2)(1) Explanation
This is for automatically adding the
.nojekyll
file.Even though there is already one in the current
gh-pages
branch, if a new contributor wants to deploy the documentation in his own fork, the.nojekyll
file will be absent, so I suggest this as a better practice for contributions.Feel free to argue about this one.
(2) Explanation with screenshots
With the updated CI, the previous
index.rst
indent produced this result:HTML malformation
Which is not expected, and not what's in the current doc online. So I fixed it.
Nitpicking: due to updated version, the design isn't exactly the same. I see no problem here though.
Current documentation (before) / documentation after CI update (after)
Preview
I uploaded the documentation on my fork, so you can see it live before approving changes.
Preview the working build: https://github.com/Ab2nour/forest-confidence-interval/actions/runs/14481813055
Preview the updated documentation: https://ab2nour.github.io/forest-confidence-interval/
Let me know if there’s anything you'd like me to adjust!