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/network/user_guide
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
..
shared_snippets uses .txt for shared content (#40416) 7 years ago
faq.rst inaugural Network FAQ (#38359) 7 years ago
index.rst Document network resource modules (#66226) 5 years ago
network_best_practices_2.5.rst Collections docs generation backport (#70515) 4 years ago
network_debug_troubleshooting.rst add note on write access to socket_path (#67060) 5 years ago
network_resource_modules.rst Document network resource modules (#66226) 5 years ago
network_working_with_command_output.rst Network prompts (#66584) 5 years ago
platform_ce.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_cnos.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_dellos6.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_dellos9.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_dellos10.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_enos.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_eos.rst fix indents of EOS Platform Options (#67564) 5 years ago
platform_eric_eccli.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_exos.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_frr.rst Add platform guide for FRR (#69773) 5 years ago
platform_icx.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_index.rst Doc backportapalooza 2 (#70440) 4 years ago
platform_ios.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_iosxr.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_ironware.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_junos.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_meraki.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_netconf_enabled.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_netvisor.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_nos.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_nxos.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_routeros.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_slxos.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_voss.rst Describe different ways to set connection timeout options (#65126) 5 years ago
platform_vyos.rst Add platform guide for FRR (#69773) 5 years ago