Skip to content

ci: stop the docs build failing on a fetch nothing needs - #53

Merged
cigamit merged 1 commit into
ctrliq:develfrom
blaipr:ci/stop-the-docs-build-failing-on-a-fetch
Sep 16, 2026
Merged

cigamit merged 1 commit into
ctrliq:develfrom
blaipr:ci/stop-the-docs-build-failing-on-a-fetch

Conversation

@blaipr

@blaipr blaipr commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

The documentation site has not published since 2026-09-13. Every run of Publish the Ascender Operator documentation fails identically:

ERROR - mkdocstrings: Couldn't load inventory https://docs.ansible.com/ansible/latest/objects.inv
        through handler 'python': HTTP Error 429: Too Many Requests
Aborted with 1 errors in strict mode!

Why that fetch exists, and why it can go

The inventory lets mkdocstrings cross reference Python symbols against the Ansible docs. No page in this repository carries a ::: directive, so the handler renders nothing and the inventory is consumed by nobody. The build has been failing on a network call for a feature the site does not use. Removed, with a comment saying where to put it back when a page needs it.

Three more things the build was reporting, once it could be read

  • Four pages exist but are in no nav entry, so nothing links to them: kind-install, container-probes, horizontal-pod-autoscaler, resource-cleanup. Added.
  • upgrading.md linked to #basic-install-on-existing-cluster, an anchor that is not on that page. It now points at the Basic Install page.
  • deploying-a-specific-version-of-awx.md linked to /home/weyerkaa/ascender-operator/roles/installer/defaults/main.yml, somebody's home directory. It now points at the file on devel.

Verification

Run locally with the command CI uses, against docs/requirements.txt:

INFO - Cleaning site directory
INFO - Building documentation to directory: .../site
INFO - Documentation built in 1.96 seconds
exit=0

No warnings, which is what --strict needs.

The documentation has not published since 2026-09-13. Every run fails the
same way:

  ERROR - mkdocstrings: Couldn't load inventory
          https://docs.ansible.com/ansible/latest/objects.inv through
          handler 'python': HTTP Error 429: Too Many Requests
  Aborted with 1 errors in strict mode!

The inventory is fetched so that mkdocstrings can cross reference Python
symbols against the Ansible documentation. No page here carries a :::
directive, so the handler renders nothing and the inventory is consumed
by nobody. The build was failing on a network call for a feature the site
does not use. It goes, with a comment saying where to put it back.

Three other things the same build reported, now that it can be read:

Four pages exist but are in no nav entry, so nothing links to them:
kind-install, container-probes, horizontal-pod-autoscaler and
resource-cleanup. They are in the nav now.

upgrading.md linked to #basic-install-on-existing-cluster, an anchor that
is not on that page. It points at the Basic Install page instead.

deploying-a-specific-version-of-awx.md linked to
/home/weyerkaa/ascender-operator/roles/installer/defaults/main.yml, which
is somebody's home directory. It points at the file on the default branch.

Verified with the command CI runs, against docs/requirements.txt:
mkdocs build --strict finishes in two seconds with no warnings and exit
zero.
@ciq-it-service-account

ciq-it-service-account commented Sep 16, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@cigamit cigamit closed this Sep 16, 2026
@cigamit

cigamit commented Sep 16, 2026

Copy link
Copy Markdown
Collaborator

Oops closed this one on accident, meant to close mine

@cigamit cigamit reopened this Sep 16, 2026
@cigamit cigamit self-assigned this Sep 16, 2026
@cigamit cigamit added the bug Something isn't working label Sep 16, 2026
@cigamit
cigamit merged commit cd717aa into ctrliq:devel Sep 16, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Development

Successfully merging this pull request may close these issues.

3 participants