Skip to content

Extra docs: generate Ansible outputs with 'antsibull-docs ansible-output' #10421

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 6 commits into
base: main
Choose a base branch
from
Open

Extra docs: generate Ansible outputs with 'antsibull-docs ansible-output' #10421

wants to merge 6 commits into from

Conversation

felixfontein
Copy link
Collaborator

SUMMARY

Use antsibull-docs ansible-output to generate Ansible output in extra docs.

I'm developing ansible-community/antsibull-docs#401 while working on this.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs/docsite/

@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-11 Automatically create a backport for the stable-10 branch labels Jul 16, 2025
@ansibullbot
Copy link
Collaborator

cc @Ajpantuso @ericzolf @giner @keilr @kellyjonbrazil @resmo
click here for bot help

@ansibullbot ansibullbot added WIP Work in progress docs labels Jul 16, 2025
@felixfontein
Copy link
Collaborator Author

The sanity tests will pass once ansible-community/antsibull-docs#401 has been merged and a new antsibull-docs version released.

I'll take a look at the code blocks in docs/docsite/rst/filter_guide-abstract_informations-lists_of_dictionaries-* once #10422 and ansible/ansible#85497 (and possibly ansible/ansible#85498) have been merged.

This was referenced Jul 17, 2025
Merged
Merged
@felixfontein felixfontein force-pushed the docs branch 2 times, most recently from ee45b79 to 2d27d1a Compare July 19, 2025 10:17
@felixfontein
Copy link
Collaborator Author

I'm now generating all output (I think), but for YAML output I need some post-processing. Right now this won't run without ansible-community/antsibull-docs#406. (Also the nox session won't produce the same results with ansible-core 2.18; I'm using ansible-core 2.19 for my tests. This will be fine next week, once 2.19.0 is released...)

@ansibullbot
Copy link
Collaborator

cc @vbotka
click here for bot help

@ansibullbot ansibullbot added callback callback plugin plugins plugin (any type) labels Jul 19, 2025
This was referenced Jul 19, 2025
Merged
Merged
Merged
@ansibullbot
Copy link
Collaborator

cc @cfiehe
click here for bot help

@ansibullbot ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Jul 28, 2025
@ansibullbot ansibullbot removed the stale_ci CI is older than 7 days, rerun before merging label Aug 4, 2025
@ansibullbot ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Aug 18, 2025
@ansibullbot ansibullbot removed the stale_ci CI is older than 7 days, rerun before merging label Aug 30, 2025
@felixfontein felixfontein changed the title [WIP] Extra docs: generate Ansible outputs with 'antsibull-docs ansible-output' Extra docs: generate Ansible outputs with 'antsibull-docs ansible-output' Aug 31, 2025
@felixfontein felixfontein marked this pull request as ready for review August 31, 2025 10:40
@felixfontein
Copy link
Collaborator Author

I think this is now ready.

@felixfontein felixfontein requested a review from russoz August 31, 2025 10:40
@ansibullbot ansibullbot removed the WIP Work in progress label Aug 31, 2025
@russoz
Copy link
Collaborator

russoz commented Aug 31, 2025

I'll take a while to go through this one, I have not used antsibull-docs ansible-output before. On a first glance it seems OK, though I have no clue what is going on in some of the blocks of changes.

@ansibullbot ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Sep 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@russoz russoz Awaiting requested review from russoz

Assignees
No one assigned
Labels
backport-11 Automatically create a backport for the stable-10 branch callback callback plugin check-before-release PR will be looked at again shortly before release and merged if possible. docs plugins plugin (any type) stale_ci CI is older than 7 days, rerun before merging
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@felixfontein @ansibullbot @russoz