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

💚 ⬆️ Fix CI/CD Docs Build Workflow and Upgrade Project Dependencies #230

Merged
merged 4 commits into from
Feb 22, 2025
Merged

💚 ⬆️ Fix CI/CD Docs Build Workflow and Upgrade Project Dependencies #230

merged 4 commits into from
Feb 22, 2025

Conversation

ebouchut
Copy link
Contributor

@ebouchut ebouchut commented Feb 21, 2025 •
edited
Loading

This PR:

  • upgrades the project dependencies (Python packages)

    Package From Version To Version
    sphinx 5.3 8.2.0
    sphinx_design 0.4.1 0.6.1
    sphinx-rtd-theme 1.2.0 3.0.2
    myst-parser 1.0.0 4.0.1
    sphinx-notfound-page 1.0.4 1.1.0

  • upgrades the outdated GitHub Actions used in the Docs build (documentation.yaml) GitHub workflow

    GitHub Action From Version To Version
    actions/checkout v3 v4
    setup/python v3 v5
    peaceiris/actions-gh-page v3 v4

  • switches to using Ubuntu 24.04 as this is now the default Ubuntu version for ubuntu-latest.

ubuntu-latest pipelines will use ubuntu-24.04 soon. For more details, see actions/runner-images#10636 .
GitHub Actions has transitioned the ubuntu-latest label to point to Ubuntu 24.04 as of January 17, 2025.
If your workflows use ubuntu-latest, they are now running on Ubuntu 24.04.
To avoid unexpected changes in your build environment,
it is recommended to specify the exact version (ubuntu-24.04) rather than using ubuntu-latest.

@ebouchut
⬆️ Upgrade Project Dependencies
7393339
@ebouchut
🔧 Add dirhtml Sphinx builder
751655c 
The default Sphinx builder is `html`
So we must explicitly set the Sphinx builder to `dirhtml`.
See: https://docs.readthedocs.com/platform/stable/config-file/v2.html#sphinx-builder
@ebouchut
💚 Upgrade GitHub Actions in the Documentation Workflow
0568bd4 
Upgrade GH actions:
- actions/checkout              to v4 from v3
- actions/setup-python@v3       to v5 from v3
- peaceiris/actions-gh-pages@v3 to v4 from v3
@ebouchut ebouchut changed the title 💚 ⬆️ Fix CI Docs build workflow and upgrade project dependencies 💚 ⬆️ Fix CI/CD Docs Build Workflow and Upgrade Project Dependencies Feb 21, 2025
@ebouchut
Copy link
Contributor Author

@psonnera If you want to have a look, I deployed it on my GH Pages here.

ebouchut
ebouchut commented Feb 21, 2025
View reviewed changes
Copy link
Contributor Author

@ebouchut ebouchut left a comment

Choose a reason for hiding this comment

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

👍 LGTM

@ebouchut ebouchut mentioned this pull request Feb 21, 2025
Merged
@ebouchut ebouchut mentioned this pull request Feb 22, 2025
Merged
@psonnera psonnera merged commit d331f54 into nightscout:source Feb 22, 2025
1 check passed
@ebouchut ebouchut deleted the fix/build_error_imghdr_not_found branch February 22, 2025 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

🐛 Error when building documentation with Python 3.13+ (No module named 'imghdr')
2 participants
@ebouchut @psonnera