Skip to content

Fixup docs build action and non-functioning readme badges - #147

Merged
kplindegaard merged 2 commits into
masterfrom
fixup/docs-build-action
Sep 10, 2026
Merged

kplindegaard merged 2 commits into
masterfrom
fixup/docs-build-action

Conversation

@kplindegaard

Copy link
Copy Markdown
Owner

Maintenance:

  • Silencing a trival sonar warnings registered for the docs build.
  • Vanity fix (!) replacing the non-functioning download counter badge

@sonarqubecloud

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The new --only-binary=:all: flag can make docs builds fail if any dependency lacks a wheel for the runner’s Python version, reducing CI reliability.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR performs maintenance on the documentation build pipeline and updates project documentation badges to restore a functioning download-count badge.

Changes:

  • Replace the PyPI downloads badge in README.md and doc/index.md with a Pepy badge.
  • Pin documentation build dependencies to exact versions in doc/requirements.txt.
  • Adjust the GitHub Actions docs-build dependency install command in .github/workflows/python-build-test.yml.
File summaries
File Description
README.md Updates the downloads badge URL to a working provider.
doc/requirements.txt Pins Sphinx/doc theme/parser dependency versions for reproducible docs builds.
doc/index.md Adds the Pepy downloads badge to the docs landing page.
.github/workflows/python-build-test.yml Modifies the docs job dependency installation command.
Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/python-build-test.yml
@kplindegaard
kplindegaard merged commit e869e3a into master Sep 10, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants