ansible

Commit Graph

Author	SHA1	Message	Date
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>	6 years ago
Christian Adams	b1f02be9eb	clarify vault warning and fix typo (#64419 )	6 years ago
Sayed Anisul Hoque	b768a0780c	Update playbooks_vault.rst (#58005 ) Corrected the internal reference link to point to the FAQ entry. +label: docsite_pr	7 years ago
Brian Coca	8ff27c4e0c	more info on how vaults work (#56183 ) also add warning about what it covers.	7 years ago
Matt Martz	db6cc60352	Migrate command line parsing to argparse (#50610 ) * Start of migration to argparse * various fixes and improvements * Linting fixes * Test fixes * Fix vault_password_files * Add PrependAction for argparse * A bunch of additional tweak/fixes * Fix ansible-config tests * Fix man page generation * linting fix * More adhoc pattern fixes * Add changelog fragment * Add support for argcomplete * Enable argcomplete global completion * Rename PrependAction to PrependListAction to better describe what it does * Add documentation for installing and configuring argcomplete * Address rebase issues * Fix display encoding for vault * Fix line length * Address rebase issues * Handle rebase issues * Use mutually exclusive group instead of handling manually * Fix rebase issues * Address rebase issue * Update version added for argcomplete support * -e must be given a value * ci_complete	7 years ago
Brian Coca	40a053ce78	better error for bad module options (#52726 ) also document clearly inline vaults don't work on 'options' fixes #52707	7 years ago
Ed Costello	0e467be0f1	Update vault docs for client scripts, multiple keys and misc (#43993 ) * Fix and update vault docs, add and clarify examples and options, introduce the concept of labeling a vault for clarity even if only a single password is in use for a given run, rework multi-password section to align to these concepts. * Document -client scripts for ansible vault. Co-Authored-By: orthanc <orthanc@users.noreply.github.com>	7 years ago
Dag Wieers	7da7ba79bc	Add anchors to some guides and all module categories (#36642 ) * Add anchors to some guides and all module categories This is required if we want to use absolute :ref: references instead of relative :doc: references. * Update the Cisco ACI Guide reference * Add `aci_guide` anchor * Add `network_guide` anchor * Add category anchor * Improve readability * Fix small typo	8 years ago
scottb	373b1dcf59	Core Docs Refactor and Redesign (#36067 ) * Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more. * Adding extra blank line for shippable	8 years ago

9 Commits (ece31e1b51ce923d4ca3a9f649fd055ab0656ece)