You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
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.
5 years ago
..
shared_snippets Add docs detailing how to convert many with_X style loops to use loop and filters (#40964) 8 years ago
basic_concepts.rst Docs: User guide overhaul, part 1 (#63056) 6 years ago
become.rst Collections docs generation (#59761) 5 years ago
collections_using.rst Collections docs generation (#59761) 5 years ago
command_line_tools.rst Docs: User guide overhaul, part 1 (#63056) 6 years ago
connection_details.rst Docs: User guide overhaul, part 2 (#65474) 6 years ago
guide_rolling_upgrade.rst Remove reference to core Ansible (#68462) 6 years ago
index.rst Docs: User guide overhaul, part 2 (#65474) 6 years ago
intro.rst Remove more docs build errors (#45364) 7 years ago
intro_adhoc.rst user_guide/intro_adhoc.rst: fix typo (#67644) 6 years ago
intro_bsd.rst Clarification for Ansible and BSD Introduction (#69275) 6 years ago
intro_dynamic_inventory.rst Redirect inventory script links (#69143) 6 years ago
intro_getting_started.rst Fix bullet points in intro_getting_started.rst. (#70365) 6 years ago
intro_inventory.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
intro_patterns.rst Update intro_patterns.rst (#67151) 6 years ago
intro_windows.rst removes last :doc: links in user guide (#58433) 7 years ago
modules.rst Collections docs generation (#59761) 5 years ago
modules_intro.rst Docs: User guide overhaul, part 1 (#63056) 6 years ago
modules_support.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbook_pathing.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks.rst Update playbooks.rst (#70317) 6 years ago
playbooks_advanced_syntax.rst Docs: User guide overhaul, part 2 (#65474) 6 years ago
playbooks_async.rst async_status: Update documentation (#70196) 6 years ago
playbooks_best_practices.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_blocks.rst Docs: User guide overhaul, part 2 (#65474) 6 years ago
playbooks_checkmode.rst WIP: Docs: User guide overhaul, part 4 (#69266) 6 years ago
playbooks_conditionals.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_debugger.rst WIP: Docs: User guide overhaul, part 4 (#69266) 6 years ago
playbooks_delegation.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_environment.rst note that environment is not good for secrets (#69618) 6 years ago
playbooks_error_handling.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_filters.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_filters_ipaddr.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_intro.rst Fix indentation (#66991) 6 years ago
playbooks_lookups.rst WIP: Docs: User guide overhaul, part 4 (#69266) 6 years ago
playbooks_loops.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_module_defaults.rst WIP: Docs: User guide overhaul, part 4 (#69266) 6 years ago
playbooks_prompts.rst Docs: User guide overhaul, part 2 (#65474) 6 years ago
playbooks_python_version.rst Upstream jinja has decided not to rename from jinja2. (#66880) 6 years ago
playbooks_reuse.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_reuse_includes.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_reuse_roles.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_roles.rst removes last :doc: links in user guide (#58433) 7 years ago
playbooks_special_topics.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_startnstep.rst WIP: Docs: User guide overhaul, part 4 (#69266) 6 years ago
playbooks_strategies.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_tags.rst all: fix all the the duplicate words (#66784) 6 years ago
playbooks_templating.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_tests.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_variables.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
playbooks_vars_facts.rst WIP: Docs: User guide overhaul, part 4 (#69266) 6 years ago
playbooks_vault.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
plugin_filtering_config.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
quickstart.rst link from quickstart page to Network Getting Started (#65150) 6 years ago
sample_setup.rst Docs: User guide overhaul, part 2 (#65474) 6 years ago
vault.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
windows.rst Windows Setup doc; offer 10x perf improvement (#58259) 6 years ago
windows_dsc.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
windows_faq.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
windows_performance.rst Windows Setup doc; offer 10x perf improvement (#58259) 6 years ago
windows_setup.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
windows_usage.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago
windows_winrm.rst Docs: User guide overhaul, part 5 (#70307) 5 years ago