Skip to content

Fix docs build #2617

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.

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

Merged
merged 2 commits into from
May 8, 2025
Merged

Fix docs build #2617

merged 2 commits into from
May 8, 2025

Conversation

felixfontein
Copy link
Collaborator

@felixfontein felixfontein commented May 7, 2025

ansible/ansible#85095 broke the docs build since AnsibleModule's documentation now references a class PluginInfo, which isn't currently documented on the docsite.

The error message is:

docs/docsite/rst/index.rst:0:0: unknown: /tmp/docs-build-ndrdw7z9-sanity/lib/ansible/module_utils/basic.py:docstring of ansible.module_utils.basic.AnsibleModule.deprecate:1: WARNING: py:class reference target not found: ansible.module_utils.common.messages.PluginInfo

@felixfontein felixfontein added the backport-2.19 Automatically create a backport for the stable-2.19 branch label May 7, 2025
@felixfontein
Copy link
Collaborator Author

So this works. The main question is where PluginInfo should be documented. I've currently added it below AnsibleModule. Maybe further down is better?

@oraNod
Copy link
Contributor

oraNod commented May 7, 2025

So this works. The main question is where PluginInfo should be documented. I've currently added it below AnsibleModule. Maybe further down is better?

I feel like it should go between basic and arg spec. Maybe since PluginInfo is provisional it should go after arg spec, but maybe a bit higher makes it more prominent?

In any case I feel like it's good to keep things in ansible.module_utils.basic and ansible.module_utils.common grouped together.

@felixfontein
Copy link
Collaborator Author

Sounds like a good idea. I've adjusted the PR accordingly, and also fixed the headling underlines to conform to https://docs.ansible.com/ansible/devel/dev_guide/style_guide/#heading-notation.

@oraNod oraNod requested review from mattclay, nitzmahone and samccann May 7, 2025 11:13
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

LGTM and thanks for the fix!

@felixfontein felixfontein marked this pull request as ready for review May 7, 2025 19:59
@felixfontein felixfontein changed the title [WIP] Fix docs build Fix docs build May 7, 2025
@samccann samccann merged commit 2bb139c into ansible:devel May 8, 2025
12 checks passed
Copy link

patchback bot commented May 8, 2025

Backport to stable-2.19: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.19/2bb139cbdcaaa29afa60477ff6e69230cd955536/pr-2617

Backported as #2620

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request May 8, 2025
* Document PluginInfo.

* Move PluginInfo before Argument Spec, and fix heading underlines.

(cherry picked from commit 2bb139c)
@felixfontein felixfontein deleted the docs branch May 8, 2025 19:58
felixfontein added a commit that referenced this pull request May 8, 2025
* Document PluginInfo.

* Move PluginInfo before Argument Spec, and fix heading underlines.

(cherry picked from commit 2bb139c)

Co-authored-by: Felix Fontein <felix@fontein.de>
@felixfontein
Copy link
Collaborator Author

@oraNod @samccann thanks for reviewing and merging!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.19 Automatically create a backport for the stable-2.19 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants