ansible

Commit Graph

Author	SHA1	Message	Date
Matt Clay	60f48ad1a3	[stable-2.14] Include subcommands in generated man pages (#81378 ) (#81383 ) Sub commands of `ansible-galaxy role` and `ansible-galaxy collection` are now documented. (cherry picked from commit `081c60b9d3`)	1 year ago
Matt Clay	63413cb0d4	[stable-2.14] Fix misrendered sections in manpage generation (#81380 ) 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. (cherry picked from commit `a84b3a4e72`) Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com>	1 year ago
Matt Clay	b42dcee567	[stable-2.14] Fix command doc lookup in man page generation (#81365 ) (#81368 ) (cherry picked from commit `f9d674fcfd`)	1 year ago
Matt Clay	aaeb2c0b08	[stable-2.14] Exclude internal options from man pages and docs (#81360 ) (#81362 ) (cherry picked from commit `fead654671`)	1 year ago
Matt Clay	dd63e31124	[stable-2.14] Remove hacking dir dependency from build backend (#81026 ) * Copy man generation files into build backend * Use copied files in build backend	1 year ago
Matt Clay	2918785895	[stable-2.14] Remove docs dir dependency from man page build (#81003 ) (#81023 ) * [stable-2.14] Remove docs dir dependency from man page build (#81003) (cherry picked from commit `b3f1290bcd`) Co-authored-by: Matt Clay <matt@mystile.com> * Update path in Makefile	1 year ago
Matt Davis	fb91d25257	Remove straight.plugin dependency (#80084 ) (#81019 ) (cherry picked from commit `f587856`)	1 year ago
Matt Clay	55b0b69545	[stable-2.14] pep517 backend - Copy symlinks when copying source (#80690 ) (#80701 ) (cherry picked from commit `54576cd794`)	2 years ago
Matt Clay	5d8fa14a7b	[stable-2.14] pep517 backend - Use correct import_module import (#80480 ) (#80502 ) (cherry picked from commit `e87802cf2c`)	2 years ago
Matt Clay	9f723d7123	[stable-2.14] 📦 Switch sdist build-system to pure setuptools (#80255 ) (#80261 ) * [stable-2.14] 📦 Switch sdist build-system to pure setuptools (#80255) This patch modifies the in-tree build backend to build sdists that swap out pointers to it in the `pyproject.toml`'s `[build-system]` section. The effect of this is that the first build from source (for example, from a Git checkout) uses our PEP 517 in-tree build backend. But the produced tarball has `build-backend` set to `setuptools.build_meta` which is the native build backend of `setuptools`. So any following builds from that sdist will skip using the in-tree build backend, calling the setuptools' one. The good news is that if the first build generated the manpages, they will be included and won't go anywhere even though, a different build system is in place. Combined with #80253, this will make sure not to modify the current source checkout on that first build. Co-authored-by: Matt Clay <matt@mystile.com> (cherry picked from commit `7097df3eed`) Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com> * Make PEP 517 mutation tests use pinned old setuptools (#80262) * Pin setuptools to lowest supported @ PEP 517 test This allows catching the behavior of builds under old setuptools. * Stop invoking `setup.py install` in tests This is not the part we care about since it involves dealing with the external runtime dependencies rather than building our source distribution. (cherry picked from commit `eebfd71a6d`) --------- Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com>	2 years ago
Sviatoslav Sydorenko	1f48032437	[stable-2.14] Make isolated source changes @ PEP 517 backend (#80253 ) (cherry picked from commit `888abf5d6e`) Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com>	2 years ago
Sviatoslav Sydorenko	913db09fbb	[backport-2.14] 🎨 Convert RST to manpage in-memory @ PEP 517 (#80237 ) * Add _convert_rst_in_template_to_manpage arg types * 📦 Make manpage build dependencies conditional Previously, said dependencies were declared as unconditionally required even when manpages not needed to be built. This patch Makes it so they are only required when needed. * Correct _generate_rst_in_templates returned type It was marked as Path before this patch but in fact, it's iterable of paths. * 🎨 Convert RST to manpage in-memory @ PEP 517 Previously, the automation was writing a temporary templated RST on disk and calling a helper CLI script on that. But with this change, it happens with less unnecessary I/O. Co-Authored-By: Matt Davis <6775756+nitzmahone@users.noreply.github.com> * 📦Expose sdist manpage build deps unconditionally Due to a bug in pypa/build, the `get_requires_for_build_sdist()` hook is always invoked with `config_settings=None`. This means that we cannot conditionally extend build requirements in said hook. As a workaround, this patch makes hook pretend that `--built-manpages` is always passed. Ref: https://github.com/pypa/build/issues/559. --------- Co-authored-by: Matt Davis <6775756+nitzmahone@users.noreply.github.com> (cherry picked from commit `67bafafbc0`) This is a backport of #80098.	2 years ago
Sviatoslav Sydorenko	bfc26f55cc	[backport-2.14] 📦 Integrate manpage builds into PEP 517 build backend (#80129 ) This patch creates a thin wrapper around the `setuptools`' PEP 517 build backend in-tree. It features an ability to request generating the manpage files in the process of building a source distribution. This toggle is implemented using the `config_settings` mechanism of PEP 517. One must explicitly pass it a CLI option to the build front-end to trigger said behavior. The packagers are expected to use the following call: python -m build --config-setting=--build-manpages This option has no effect on building wheels. 🧪 The change includes integration tests This test runs building and re-building sdists and wheels with and without the `--build-manpages` config setting under the oldest-supported and new `setuptools` pinned. It is intended to preserve the interoperability of the packaging setup across Python runtimes. An extra smoke test also verifies that non PEP 517 interfaces remain functional. PR #79606 Co-authored-by: Matt Clay <matt@mystile.com> (cherry picked from commit `56036013cd`)	2 years ago

13 Commits (60f48ad1a37dc60880545a6db8f03f83c0435ccd)