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>	4 years ago
Sandra McCann	b2fc12a29f	clean up network toc (#65264 )	5 years ago
Sandra McCann	cca365061c	add how to create HttpApi plugins for network modules (#54340 ) * initial port over from gdoc * crosslink httpapi pages * Add some examples? * Add quick example of using Connection * Fix indentation of python code blocks * moved to a full developer guide for networks * Try to clarify some examples * Fix typos How did I even do that?	6 years ago
Sandra McCann	1c42198f1e	fixed network automation index issues (#44732 ) * fixed network automation index issues * replace :doc: with :ref: * fixed anchor misspelling * fix toc/nav issue -do not put toctree under a subheader	6 years ago
Alicia Cozine	8f83061e70	corrects links to 'list_of' pages (#39161 )	7 years ago
Alicia Cozine	0ebc0b9e5a	adds FAQ TOC entry, links & examples to modules (#38706 ) * adds FAQ TOC entry, links & examples to modules * moves link to Notes, corrects examples	7 years ago
Alicia Cozine	4f63123320	Network Platform docs (#36814 ) * introduces platform docs	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	7 years ago
Alicia Cozine	51a010a696	Network Getting started docs (#36337 ) * first draft of getting started guide	7 years ago

9 Commits (2ff5bf0f2195851d2558f5aab72acd977e0f44ae)