4 Commits (c86a498a676962534b8a211fad0e977a6e5bca4d)

Author	SHA1	Message	Date
Alicia Cozine	c86a498a67	Backport of Split Ansible docs from core docs (#73616) (#73637) ... * Split Ansible docs from core docs (#73616) * excludes scenario guides from core docs, splits porting guides and roadmaps, symlinks indices to create index.html pages, and adds .gitignore entries for conf.py and the toplevel index.rst files generated by the docs build This solution builds three types of docs: * ansible-2.10 and earlier: all the docs. Handle this via `make webdocs ANSIBLE_VERSION=2.10` * ansible-3 and later: a subset of the docs for the ansible package. Handle this via `make webdocs ANSIBLE_VERSION=3` (change the ANSIBLE_VERSION to match the version being built for. * ansible-core: a subset of the docs for the ansible-core package. Handle this via `make coredocs`. * `make webdocs` now always builds all the collection docs * Use `make coredocs` to limit it to core plugins only * The user specifies the desired version. If no ANSIBLE_VERSION is specified, build plugins for the latest release of ansible Co-authored-by: Toshio Kuratomi <a.badger@gmail.com> Co-authored-by: Matt Clay <matt@mystile.com> (cherry picked from commit ccbfdec334) * fix CI failures, correct version switcher and makefile logic, set args in all cases, allow 2.10 build Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>	5 years ago
Toshio Kuratomi	7662568bd8	Antsibull build format backport 71080 (#71285) ... * Updates to docs build for new antsibull CLI * --ansible-base-cache renamed to --ansible-base-source * _acd_version in the .deps file has been renamed to _ansible_version (cherry picked from commit 22d2c97b81) * Fix expr regex for MacOSX compat MacOSX seems to want bare `+` whereas GNU expr wants escaped `+` (`\+`) to mean match one or more. Use `\{1,\}` instead which will match one or more on both MaxOSX and GNU-using systems. Fixes #71053 (cherry picked from commit 99cac0b135) * Force an upgrade to a newer version of antsibull (cherry picked from commit d816a5966e)	5 years ago
Toshio Kuratomi	72aa55d514	[stable-2.10] Fix version comparison for determining what ansible to build against (#71152) ... * The version comparison for determining what ansible package to build docs against was comparing the version number for ansible-base but it needed to check the version number for ansible instead * add a comment about some bad logic than needs to be fixed after 2.10.0 (cherry picked from commit 37a7485) Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>	5 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>	5 years ago