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
David Shrewsbury f0ec10dbc3
Role arg spec validation implementation (#73152)
* Initial import of modified version of alikins' code
* Add unit testing for new Role methods
* Fix validate_arg_spec module for sanity test. Add test_include_role_fails.yml integration test from orig PR.
* Add testing of suboptions
* Use new ArgumentSpecValidator class instead of AnsibleModule
* fix for roles with no tasks, use FQ name of new plugin
* Add role dep warning
4 years ago
..
_extensions More boilerplate fixes. (#70224) 5 years ago
_static Docs: improve anchors vs. header bar (#67244) 5 years ago
_themes/sphinx_rtd_theme left a stray </div> by mistake (#73132) 4 years ago
js/ansible consolidated docs 8 years ago
rst Role arg spec validation implementation (#73152) 4 years ago
.gitignore fix rstcheck problem and gitignore collections dir (#70764) 4 years ago
.nojekyll consolidated docs 8 years ago
Makefile Add link to all module and plugin indexes (#72743) 4 years ago
Makefile.sphinx Adds the ability to override the doc build output directory from the command line. (#36604) 7 years ago
README.md Adds FAQ and other pointers for collections (#71606) 4 years ago
ansible_2_5.inv updates intersphinx references for docs links (#71921) 4 years ago
ansible_2_6.inv updates intersphinx references for docs links (#71921) 4 years ago
ansible_2_7.inv updates intersphinx references for docs links (#71921) 4 years ago
ansible_2_8.inv updates intersphinx references for docs links (#71921) 4 years ago
ansible_2_9.inv updates intersphinx references for docs links (#71921) 4 years ago
ansible_2_10.inv updates intersphinx references for docs links (#71921) 4 years ago
collection-plugins.yml Collections docs generation (#59761) 4 years ago
jinja2.inv Intersphinx (#68090) 5 years ago
modules.js consolidated docs 8 years ago
python2.inv Add a script to update the intersphinx inventory (#66646) 5 years ago
python3.inv updates intersphinx references for docs links (#71921) 4 years ago
requirements.txt update the docs requirements versions (#73108) 4 years ago
variables.dot consolidated docs 8 years ago

README.md

Ansible documentation

This project hosts the source behind the general pages of docs.ansible.com. Module-specific documentation is hosted in the various collections repositories. See Ansible Galaxy, the list of Ansible-maintained collections, and the ansible-collections organization for collections sources.

To create clear, concise, and consistent contributions to Ansible documentation, please refer to the following information.

Contributions

Contributions to the documentation are welcome.

The Ansible community produces guidance on contributions, building documentation, and submitting pull requests, which you can find in Contributing to the Ansible Documentation.

You can also join the Docs Working Group and/or the #ansible-docs channel on freenode IRC.

Ansible style guide

Ansible documentation is written in ReStructuredText(RST). The Ansible style guide provides linguistic direction and technical guidelines for working with reStructuredText, in addition to other resources.

Tools

The Ansible community uses a range of tools and programs for working with Ansible documentation. Learn more about Other Tools and Programs in the Ansible Community Guide.

GitHub

Ansible documentation is hosted on the Ansible GitHub project and various collection repositories, especially those in the ansible-collections organization. For general GitHub workflows and other information, see the GitHub Guides.