ansible/docs/docsite/rst
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.
2020-07-17 13:07:35 -07:00
..
api remove build errors including guess (#69711) 2020-05-29 11:56:49 -05:00
community partial update of community docs to reflect collections transition (#70488) 2020-07-14 15:47:18 -04:00
dev_guide partial update of community docs to reflect collections transition (#70488) 2020-07-14 15:47:18 -04:00
galaxy Add support to install collections from git repositories (#69154) 2020-05-29 13:33:32 -04:00
images
installation_guide Remove RPM packaging infrastructure (#69554) 2020-05-15 20:29:05 -05:00
inventory Add implicit localhost hostvars note (#61956) 2019-09-16 14:00:29 -04:00
network Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
plugins Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
porting_guides Replace filename with file in apt_key (#70492) 2020-07-10 12:42:49 -04:00
reference_appendices Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
roadmap update roadmap rc1 date (#70662) 2020-07-15 11:47:36 -07:00
scenario_guides Minor grammatical fix (#70405) 2020-07-01 10:47:08 +05:30
shared_snippets Add support to install collections from git repositories (#69154) 2020-05-29 13:33:32 -04:00
user_guide Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
404.rst
conf.py Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
index.rst Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00