Skip to content

Intersphinx #3089

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
Open
wants to merge 3 commits into
base: devel
Choose a base branch
from
Open

Intersphinx #3089

wants to merge 3 commits into from
+1 −1

Conversation

samccann
Copy link
Contributor

@samccann samccann commented Oct 3, 2025

Fixes #2546

@samccann samccann requested a review from oraNod October 3, 2025 18:51
@samccann samccann added the backport-2.19 Automatically create a backport for the stable-2.19 branch label Oct 3, 2025
felixfontein
felixfontein reviewed Oct 5, 2025
View reviewed changes
@oraNod
Copy link
Contributor

oraNod commented Oct 7, 2025

@felixfontein Hey, just curious about this docs build error that's failing in CI:

docs/docsite/rst/dev_guide/developing_collections_documenting.rst:15:0: undefined-label: undefined label: 'ansible_collections.sensu.sensu_go.install_role'

It comes from this line which uses semantic markup.

Weirdly if I revert my last commit that removes the Ansible 11 intersphinx link, that error goes away. However several new errors seem to arise, which I can also see on devel when running the docs-build check.

docs/docsite/rst/2.10_index.rst:23:0: warning: toctree contains reference to excluded document 'porting_guides/porting_guides'
docs/docsite/rst/2.10_index.rst:48:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/cloud_guides'
docs/docsite/rst/2.10_index.rst:48:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/network_guides'
docs/docsite/rst/2.10_index.rst:48:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'scenario_guides/virt_guides'
docs/docsite/rst/2.10_index.rst:57:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'network/getting_started/index'
docs/docsite/rst/2.10_index.rst:57:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'network/user_guide/index'
docs/docsite/rst/2.10_index.rst:57:0: toc-tree-missing-document: toctree contains reference to nonexisting document 'network/dev_guide/index'
docs/docsite/rst/2.10_index.rst:102:0: warning: toctree contains reference to excluded document 'roadmap/index'
docs/docsite/rst/2.10_index.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/community/contributor_license_agreement.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/community/triage_process.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/dev_guide/developing_modules_general_aci.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/user_guide/guide_rolling_upgrade.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/user_guide/intro_getting_started.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/user_guide/playbooks_templating.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/user_guide/quickstart.rst:0:0: not-in-toc-tree: document isn't included in any toctree

@oraNod
Copy link
Contributor

oraNod commented Oct 7, 2025 •
edited
Loading

OK, maybe some of that was a me problem. I cleaned house and grabbed a fresh clone and those toc-tree issues went away. Somehow I ended up with a bunch of orphans on my filesystem that were gitignored.

However we still have that docs-build failure if the Ansible 11 intersphinx is removed.

@felixfontein
Copy link
Collaborator

sensu.sensu_go was still included in Ansible 11, but removed from Ansible 12. The markup needs to be fixed, it's no longer possible to link to the role since it's not part of Ansible anymore.

Here's a list of potential replacement roles: https://docs.ansible.com/ansible/devel/collections/index_role.html

@oraNod
Copy link
Contributor

oraNod commented Oct 8, 2025

sensu.sensu_go was still included in Ansible 11, but removed from Ansible 12. The markup needs to be fixed, it's no longer possible to link to the role since it's not part of Ansible anymore.

Here's a list of potential replacement roles: https://docs.ansible.com/ansible/devel/collections/index_role.html

Thanks very much @felixfontein

@oraNod oraNod mentioned this pull request Oct 8, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@felixfontein felixfontein felixfontein approved these changes

@oraNod oraNod Awaiting requested review from oraNod

Assignees
No one assigned
Labels
backport-2.19 Automatically create a backport for the stable-2.19 branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation Checklist: Ansible 12 release
3 participants
@samccann @oraNod @felixfontein