ansible

Commit Graph

Author	SHA1	Message	Date
Sandra McCann	db5b2faf2e	pin docutils to 0.16 until theme problem is fixed (#74193 ) (#74399 ) (cherry picked from commit `7443e9d659`)	4 years ago
Sandra McCann	a8ebe99c98	Revert "update the docs requirements versions (#73108 ) (#73251 )" This reverts commit `ee46fe2910`.	4 years ago
Sandra McCann	ee46fe2910	update the docs requirements versions (#73108 ) (#73251 ) (cherry picked from commit `0936623901`)	4 years ago
Toshio Kuratomi	46b1a999c6	Collections docs generation backport (#70515 ) * Build documentation for Ansible-2.10 (formerly known as ACD). Builds plugin docs from collections whose source is on galaxy The new command downloads collections from galaxy, then finds the plugins inside of them to get the documentation for those plugins. * Update the python syntax checks * docs builds can now require python 3.6+. * Move plugin formatter code out to an external tool, antsibull-docs. Collection owners want to be able to extract docs for their own websites as well. * The jinja2 filters, tests, and other support code have moved to antsibull * Remove document_plugins as that has now been integrated into antsibull-docs * Cleanup and bugfix to other build script code: * The Commands class needed to have its metaclass set for abstractmethod to work correctly * Fix lint issues in some command plugins * Add the docs/docsite/rst/collections to .gitignore as everything in that directory will be generated so we don't want any of it saved in the git repository * gitignore the build dir and remove edit docs link on module pages * Add docs/rst/collections as a directory to remove on make clean * Split the collections docs from the main docs * remove version and edit on github * remove version banner for just collections * clarify examples need collection keyword defined * Remove references to plugin documentation locations that no longer exist. * Perhaps the pages in plugins/.rst should be deprecated altogether and their content moved? If not, perhaps we want to rephrase and link into the collection documentation? * Or perhaps we want to link to the plugins which are present in collections/ansible/builtin? * Remove PYTHONPATH from the build-ansible calls One of the design goals of the build-ansible.py script was for it to automatically set its library path to include the checkout of ansible and the library of code to implement itself. Because it automatically includes the checkout of ansible, we don't need to set PYTHONPATH in the Makefile any longer. * Create a command to only build ansible-base plugin docs * When building docs for devel, only build the ansible-base docs for now. This is because antsibull needs support for building a "devel tree" of docs. This can be changed once that is implemented * When building docs for the sanity tests, only build the ansible-base plugin docs for now. Those are the docs which are in this repo so that seems appropriate for now. * Docs: User guide overhaul, part 5 (#70307) (cherry picked from commit `db354c0300`) * Need to return any error code from running antsibull-docs (#70763) This way we fail early if there's a problem (cherry picked from commit `1e3989c9f7`) Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>	4 years ago
Sandra McCann	c936b8b638	[backport][2.10]Docs backportapalooza3 (#70695 ) * Suggest ansible ad-hoc command while developing module (#70308) If a local module has no documentation, the doc command will fail without any hints of what is wrong. Add another way to confirm the presence of a local module. * Update docs/docsite/rst/dev_guide/developing_locally.rst Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `82e5d03bdb`) * Update AWS Integration test docmentation (#70454) (cherry picked from commit `e1ba7dc52a`) * Update hacking/shippable docs. The `--all` option downloads more than is needed for analyzing code coverage. (cherry picked from commit `fb7740ae3b`) * Document that subversion module requires subversion (#70537) (cherry picked from commit `64c2cb273f`) * update documentation link to python 3 (#70509) update the docs link for strftime on the filters page to point to the python3 docs (cherry picked from commit `f7db428375`) * Update windows_winrm.rst (#70306) gcc also needed to be installed alongside python-devel, krb5-devel, krb5-libs, and krb5-workstation. (cherry picked from commit `f4ea43c4a0`) * updated requirements file for docs build (#70609) (cherry picked from commit `38ccfb4a3e`) * Clarify that index_var is 0 indexed (#70548) A little further down the page is another index, ansible_loop.index, which shares a similar description but is 1 indexed. Its zero indexed twin has a 0 suffix. ``ansible_loop.index`` The current iteration of the loop. (1 indexed) ``ansible_loop.index0`` The current iteration of the loop. (0 indexed) To remove ambiguity around the usage of index_var, explicitly mention that this variable is 0 indexed. (cherry picked from commit `c410311f55`) * docs: update module development docs (#70594) Update module development docs for flattened modules directory. Fixes: #70261 (at least partially) Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `20209c508f`) * Doc: fix examples of changelog entries. (#70551) (cherry picked from commit `edcd1a1a70`) * Document tags are not supported with task meta. (#70590) fixes #70338 (cherry picked from commit `40591d5fbb`) * docs: update date format in removed_at_date (#70597) removed_at_date requires YYYY-MM-DD format. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit `375c6b4ae4`) * partial update of community docs to reflect collections transition (#70488) (cherry picked from commit `f1f782fc37`) Co-authored-by: Michael Ritsema <michaelritsema@users.noreply.github.com> Co-authored-by: Mark Chappell <mchappel@redhat.com> Co-authored-by: Matt Clay <matt@mystile.com> Co-authored-by: Alan Rominger <arominge@redhat.com> Co-authored-by: FloMiau <37121807+FloMiau@users.noreply.github.com> Co-authored-by: mahadelmi <mahadelmi@cmail.carleton.ca> Co-authored-by: Sayee <57951841+sayee-jadhav@users.noreply.github.com> Co-authored-by: Karl Goetz <goetzk@users.noreply.github.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>	4 years ago
Sayee	1d63b6f4f8	updated requirements file for docs build (#70020 )	5 years ago
Toshio Kuratomi	019d078a5a	Move common build code from _build_helpers (#55986 ) We have some common code used by several docs scripts. Migrate that into the build-only shared code repository. * Move lib/ansible/utils/_build_helpers.py to the directory for common build code * Migrate docs/bin/dump_config.py to a build-ansible subcommand * Migrate dump_keywords to the build-ansible framework * Make the script more maintainable by using functions and good variable names * Port to Python3 idioms * Fix bug so that private attributes will be undocumented * Move generate_man to a build-ansible subcommand * Port plugin_formatter to a build-ansible subcommand * Rework command_plugins so that docs scripts can target Python-3.4+ and releng-only subcommands can use more recent versions of Python. The architecture is now that command_plugins/* need to be importable on Python-3.4. The init_parsers() method needs to run on Python-3.4. But the main() method can utilize features of more recent Python as long as it fits within those parameters. * Update docs build requirements Port the plugin_formatter to build-ansible framework	5 years ago
Felix Fontein	505c99265c	docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508 ) * Remove lexers which have been fixed in Pygments 2.4.0. * Add Pygments >= 2.4.0 to test runner. * Fix pages that triggered lexer errors. Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>	6 years ago
Alicia Cozine	e834cd7d41	updates reqs for building docs locally (#57967 )	6 years ago
Sebastian Meyer	3f97abc6e2	Add PyYAML to docs requirements.txt (#53521 ) When building the docs in a virtualenv we need to install PyYAML in addition to sphinx, otherwise the `import yaml` will fail.	6 years ago
Matt Clay	a4c9f57b38	Move docsite requirements to the docs/docsite dir. (#46518 )	6 years ago

11 Commits (add2dca4b13840b3db044bb0db149cc7b1b4f511)