Commit Graph

3596 Commits (5a44acc7049f709a4608f945ab3fe2ac4bbdff36)

Author SHA1 Message Date
Christinanik251 5a44acc704
Update P() semantic markup example (#80464) 1 year ago
Sviatoslav Sydorenko a84b3a4e72
Fix misrendered sections in manpage generation
This change fixes bugs in the manpage generator that existed since it
was first added.

It exposes CLI `ARGUMENTS` value to manpage templates.

Before this change, the code contained a typo, causing the `for`-loop
iterate over individual characters of the `'ARGUMENTS'` string rather
than iterating over a tuple. A missing comma was at fault.

The updated code gets rid of the `for`-loop and conditionals since it
seems to have been a premature complexity increase and no other things
than `'ARGUMENTS'` were ever added into the broken iterable.

The functional change is that `arguments` is now always present in the
Jinja2 context, unlike being missing sometimes because of the previous
design (not that it was ever present, because of the bug! sigh...)

The Jinja2 templates perform an `{% if arguments %}` check, letting
the template engine silently ignore the missing variable. The clause
was always falsy, meaning that the arguments section was not included
in the manpages for at least the last 6 years. With this fix, it will
be.

This patch also deduplicates calling `opt_doc_list` @ generate_man.

It was called late in the execution, more times than necessary. This
patch makes sure it happens once by putting it at the top of the scope.

It fixes rendering library and inventory in manpages.

The corresponding Jinja2 templates have blocks wrapped with
conditionals like `{% if inventory %}` and `{% if library %}` but said
variables were never injected into the context, nor were they even
deduced on the Python side of the generator. This means that the
conditional clauses were always falsy, never showing the portions of
the manpages.

The Python script has hints for how the `inventory` variable was to be
calculated, which is confirmed through the Git paleontology efforts.

The block of code that references to the `inventory` bit was
incorrectly checking a variable with a list of nested objects for the
presence of a string which was never going to work.

This patch fixes this check by verifying the CLI flag against the
correct variable containing a list of options and exposes it to the
Jinja2 templates.
It also exposes the `library` variable in a similar way.

The block displaying other binaries in Sphinx CLI docs has been
synchronized with the manpage template.
Previously, the current binary was displayed also. This patch gets rid
of the unwanted trailing comma there too.

Finally, the CLI executables list in the manpage template now reuses
the same variable as the RST template that doesn't need any
post-processing in Jinja2.
Before, it was already used in the RST template so this patch aligns
both templates to use the same logic as they got out-of-sync over time.

PR #80450.
1 year ago
Yiannis af6d75e313
Add OpenSUSE to the distro's installation guide (#80308)
* Add OpenSUSE to the distro's installation guide

Similar to the rest of the distros, OpenSUSE distributes ansible and it was
missing.

Signed-off-by: ybonatakis <ybonatakis@suse.com>
1 year ago
Daniel-at-github ec403db1c7
Document how to run all tasks, even the ones with the never tag (#80315)
Co-authored-by: Martin Krizek <martin.krizek@gmail.com>
1 year ago
dzvision a6e0012b8a
Update playbooks_templating.rst (#80375) 1 year ago
WeiXinFam-Insta 0460f78081
Documentation changes for #80367 and #80270 (#80391) 1 year ago
Andrew Klychkov db8f1756bc
[Docs] communication.rst: Add a hint about adding Matrix shields to READMEs (#80392) 1 year ago
Sviatoslav Sydorenko 88a380c8f0
📝 Document macOS user deletion over SSH (#80358)
Co-authored-by: Matt Clay <matt@mystile.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
1 year ago
Felix Fontein 4029da9a9f
Semantic markup docs (#80240)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Matt Clay <matt@mystile.com>
1 year ago
Matt Davis 5e131a96c0
bump devel to 2.16.0.dev0 (#80390) 1 year ago
Sviatoslav Sydorenko a45dd2a01c
🐛📝 Undouble trailing colon @ `faq.rst` (#80359)
It is causing parsing/representation problems of the following
explicit RST code block.
1 year ago
Felix Fontein cf44c84396
Add antsibull-changelog and antsibull-docs to other tools and programs page. (#80340) 1 year ago
Matt Clay 0cfdf0ad59
Use a dedicated version helper for the docs build (#80345)
This removes the dependency on the release version helper in the docs-build sanity test.
1 year ago
Matt Clay 1d6f019ce6
Remove obsolete integration test aliases (#80342)
* Remove obsolete integration test aliases

* Remove obsolete `skip/osx` aliases

* Use `skip/macos` instead of `skip/osx` in docs
1 year ago
Anwesha Das 29e0a68af2
Add Ansible community 7.4.0 porting guide (#80338) 1 year ago
Achim fc9415eeb4
"Ansible Lint" IntelliJ plugin added (#80263) 2 years ago
Felix Fontein 4ea50cef23
validate-modules: check_mode attribute and compare with supports_check_mode parameter (#80090)
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
2 years ago
Sandra McCann cba3952434
Move Collection requirements to ansible/ansible (#80234) 2 years ago
Benoît Geeraerts 1491ec8019
Update special_variables.rst (#80210)
The usage of a glossary on this page will allow linking to a specific special variable, like on the glossary page, e.g.: https://docs.ansible.com/ansible/latest/reference_appendices/glossary.html#term-Idempotency
2 years ago
Esther Christopher 0937cc4862
Update connection.rst (#80194) 2 years ago
Alicia Cozine 507fd1bd60
Document debugging conditionals (#80239)
##### SUMMARY
Add a section to the docs describing how to debug conditional statements - how to get Ansible to show you whether your `when:` clause evaluates to `true` or `false`.

I ran into trouble with this and couldn't find anything in the docs. Thought I'd add it.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2 years ago
Matt Clay bad8843124
ansible-test - Update git diff handling (#80202)
This change allows ansible-test to work with newer versions of git on AZP.
2 years ago
Kristian Heljas 7ce951ff48
Adjust release schedule docs to four weeks (#80166) 2 years ago
Don Naro 1055803c3a
docsite requirements path (#80134) 2 years ago
Jairo Llopis 3216e071c7
docs: automatic `always` tag in gather_facts (#80052) 2 years ago
Keeper-of-the-Keys cc8e6d06d0
Update playbooks_conditionals.rst (#80062)
"changed" was missing from the docs
2 years ago
Sandra McCann 0521184337
clarify playbook tests (#80073) 2 years ago
Andreas Deininger 841b71c94f
Fixing typos (#80045) 2 years ago
Akira Yokochi 012393e2cd
fix link for development guidelines (#80055) 2 years ago
Kristian Heljas 02c49ffe60
Encourage true/false for module documentation (#80060)
Co-authored-by: Felix Fontein <felix@fontein.de>
2 years ago
Nicolas P c8f740cfee
Fix typo docs in playbooks_tags.rst (#80117) 2 years ago
Don Naro 352010f9c3
improve doc dependency install steps (#80120) 2 years ago
Anwesha Das dbcaab1012
Add Ansible community 7.3.0 porting guide (#80106) 2 years ago
Matt Clay f587856beb
Remove straight.plugin dependency (#80084) 2 years ago
Raphael Michel 563833d124
Docs: Clarify note on tags (#80079)
The current wording could be read as "tasks that are tagged *both* configuration and packages" while in fact it is "tasks that are tagged *either* configuration *or* packages"
2 years ago
Desmond Obisi 5ad77fc7bb
fix: jinja complex type transforms doesn't work as documented (#80067)
jinja complex type transforms: dict(somelist| slice(2)) doesn't work as documented. Changed the example to use zip_longest
2 years ago
Aastha Varma 940fdf5dba
consistent booleans for page text and code blocks (#80036)
* consistent booleans for page text and code blocks

* Update check_mode from n to false
2 years ago
Player256 ce5471fc9f
Update collection_integration_updating.rst (#80037) 2 years ago
nkakouros 998b5c1a06
Clarify when plugin settings are being populated (#79710) 2 years ago
Gijikiki ed879954f9
Update playbooks_tests.rst (#79788) 2 years ago
Don Naro 9f02e505d9
add wheel to docsite pre-reqs #79513 (#80061) 2 years ago
Anže Luzar 122de95d85
Add Steampunk Spotter to Other tools list (#80006) 2 years ago
Matt Clay a4248a63aa
Add missing newlines to YAML files (#80031) 2 years ago
Sandra McCann f841c2803a
update banner' (#79971) 2 years ago
Matt Martz 54ff9afa10
Data tagging delayed to 2.16 (#80011) 2 years ago
Alicia Cozine 75274021d3
fixes typo in Ansible 7 roadmap (#79996)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2 years ago
Alicia Cozine 0946ee2f14
adds roadmap for Ansible 8 (#79598) 2 years ago
Sandra McCann d47a848219
fix core devel doc output (#79902) 2 years ago
Sandra McCann dc99005820
Rst fixes (#79939)
* fix rstcheck errors for 6.1.1
* spell shell correctly
2 years ago
Alicia Cozine 5f947f867c
make this a warning, not a comment (#79928)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2 years ago