ansible/docs/docsite/rst/user_guide
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
..
shared_snippets
basic_concepts.rst Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
become.rst Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
collections_using.rst Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
command_line_tools.rst Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
connection_details.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
guide_rolling_upgrade.rst Remove reference to core Ansible (#68462) 2020-03-26 15:22:36 -04:00
index.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
intro.rst
intro_adhoc.rst user_guide/intro_adhoc.rst: fix typo (#67644) 2020-02-21 10:56:25 +00:00
intro_bsd.rst Clarification for Ansible and BSD Introduction (#69275) 2020-05-04 16:16:41 -05:00
intro_dynamic_inventory.rst Redirect inventory script links (#69143) 2020-04-29 16:05:39 -04:00
intro_getting_started.rst Fix bullet points in intro_getting_started.rst. (#70365) 2020-06-29 14:05:05 -05:00
intro_inventory.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
intro_patterns.rst Update intro_patterns.rst (#67151) 2020-02-11 11:52:00 -06:00
intro_windows.rst
modules.rst Collections docs generation (#59761) 2020-07-17 13:07:35 -07:00
modules_intro.rst Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
modules_support.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbook_pathing.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks.rst Update playbooks.rst (#70317) 2020-07-02 11:11:09 -04:00
playbooks_advanced_syntax.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
playbooks_async.rst async_status: Update documentation (#70196) 2020-06-23 11:45:54 -04:00
playbooks_best_practices.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_blocks.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
playbooks_checkmode.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_conditionals.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_debugger.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_delegation.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_environment.rst note that environment is not good for secrets (#69618) 2020-05-28 15:24:32 -05:00
playbooks_error_handling.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_filters.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_filters_ipaddr.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_intro.rst Fix indentation (#66991) 2020-02-03 12:30:12 -05:00
playbooks_lookups.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_loops.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_module_defaults.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_prompts.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
playbooks_python_version.rst Upstream jinja has decided not to rename from jinja2. (#66880) 2020-01-30 10:57:50 -05:00
playbooks_reuse.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_reuse_includes.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_reuse_roles.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_roles.rst
playbooks_special_topics.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_startnstep.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_strategies.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_tags.rst all: fix all the the duplicate words (#66784) 2020-01-28 14:06:40 -05:00
playbooks_templating.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_tests.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_variables.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
playbooks_vars_facts.rst WIP: Docs: User guide overhaul, part 4 (#69266) 2020-05-15 16:18:07 -04:00
playbooks_vault.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
plugin_filtering_config.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
quickstart.rst link from quickstart page to Network Getting Started (#65150) 2019-11-21 11:42:57 -05:00
sample_setup.rst Docs: User guide overhaul, part 2 (#65474) 2019-12-12 13:35:17 -05:00
vault.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
windows.rst
windows_dsc.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
windows_faq.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
windows_performance.rst
windows_setup.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
windows_usage.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00
windows_winrm.rst Docs: User guide overhaul, part 5 (#70307) 2020-07-14 17:00:44 -04:00