ansible

Commit Graph

Author	SHA1	Message	Date
Toshio Kuratomi	9dda393d70	Collections docs generation (#59761 ) * 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.	4 years ago
Sloane Hertel	34458f3569	Update inventory caching documentation (#69100 )	5 years ago
Sloane Hertel	a4b36b2e6a	Update cache plugin documentation (#63635 ) * Update cache plugin documentation since all cache plugins shipped with Ansible can be used for caching inventory since 2.8 * Update docs/docsite/rst/plugins/cache.rst Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com> Co-Authored-By: John R Barker <john@johnrbarker.com>	5 years ago
Sloane Hertel	d41050b28b	Add some documentation about plugins in collections (#62465 ) * Add some documentation about using plugins in collections - FQCN requirements - Sharing code in collections - Limitations with inventory caching	5 years ago
Alicia Cozine	e700309618	Refine plugin docs (#49324 ) * local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages	6 years ago
Sloane Hertel	c4d1f0d416	Add docs for inventory caching (#46402 ) * Add docs for inventory caching * Fix subsection headers * Fix top header	6 years ago
Alicia Cozine	408e29cbd2	Link fixes (#39038 ) * fixes links on plugins pages * fixes links in community pages * fixes links in user guide * adds anchors on playbooks pages	7 years ago
Michihito Shigemura	c34c1b6ebd	Fix typo/link in plugins/cache	7 years ago
Brian Coca	2ed46e04f4	more updates to plugin/config generation (#30787 ) * fixed module generation added missing lookup page point to plugins when plugins made modules singular add display for verbose an debug messages nicer templating, changed generation order for ref corrected links moved most of lookup docs to plugin section * Copy edits * Fixed typos * Clarified wording	7 years ago
scottb	6c732bb670	Plugin doc update edits for #30490 (#30889 ) * Edit pass 1 for #30490 - command line tools and developing plugins. * Continuing edit pass for #30490. WIP * Last round of copy edits for #30490.	7 years ago
Brian Coca	b233f3f296	updated plugin docs (#30490 ) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page	7 years ago

11 Commits (a33cc191bd66d800302edbd1400daaaa7915790e)