diff options
| author | Adrian Likins <alikins@redhat.com> | 2017-09-19 11:14:27 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-19 11:14:27 -0400 |
| commit | da15cf1f54779b10e2186b3e6da6d609b4aebba7 (patch) | |
| tree | 1b63a29086149d7dcdd170949f1275b5c8454000 /.gitignore | |
| parent | 76aaaf127bea947c5eb559f79cc7926aabdababd (diff) | |
| download | ansible-da15cf1f54779b10e2186b3e6da6d609b4aebba7.tar.gz | |
Generate plugin rst (#28901)
Generate rst docs for plugins
Based on rst generated for modules. But generated plugin
docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst
( docs/docsite/rst/plugins/connection/ssh.py for ex)
* move plugins docs to rst/*_plugins/ subdirs for namespace
* Only gen support pages for modules for now.
* Add generated plugin docs to gitignore* add list_*_plugins templates
* support MODULES/PLUGINS filters for make htmldocs
Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for.
* fixup 'historical' version_added, skip plugins/loader.py
* Fix plugins_by_support ref link to new plugins/*/ location
* use :ref: for common_return_values, allow empty version_added
* warnings on missing doc info
* add a prefix to _random_choice
It was colliding with the target for random_choice plugin
Diffstat (limited to '.gitignore')
| -rw-r--r-- | .gitignore | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore index fa8e566a90..78f9525283 100644 --- a/.gitignore +++ b/.gitignore @@ -33,10 +33,12 @@ docs/docsite/rst/core_maintained.rst docs/docsite/rst/list_of_*.rst docs/docsite/rst/*_module.rst docs/docsite/rst/modules_by_category.rst +docs/docsite/rst/plugins_by_category.rst docs/docsite/rst/network_maintained.rst docs/docsite/rst/partner_maintained.rst docs/docsite/rst/playbook_keywords.rst docs/docsite/rst/playbooks_directives.rst +docs/docsite/rst/plugins/ docs/docsite/*.html docs/docsite/_static/*.gif docs/docsite/_static/*.png @@ -44,6 +46,7 @@ docs/docsite/_static/websupport.js docs/docsite/searchindex.js docs/docsite/htmlout docs/docsite/_build +docs/docsite/rst_warnings docs/api/rst/ docs/api/_build/ # deb building stuff... |