40f21dfd3c
* Track collection for version_added. Validate *all* version numbers in validate-modules. For tagged version numbers (i.e. version_added), consider source collection to chose validation. * Make tagging/untagging functions more flexible. * Tag all versions in doc fragments. * Tag all deprecation versions issued by code. * Make Display.deprecated() understand tagged versions. * Extend validation to enforce tagged version numbers. * Tag versions in tests. * Lint and fix test. * Mention collection name in collection loader's deprecation/removal messages. * Fix error IDs. * Handle tagged dates in Display.deprecated(). * Also require that removed_at_date and deprecated_aliases.date are tagged. * Also automatically tag/untag removed_at_date; fix sanity module removal version check. * Improve error message when invalid version number is used (like '2.14' in collections). |
||
|---|---|---|
| .. | ||
| _extensions | ||
| _static | ||
| _themes/sphinx_rtd_theme | ||
| js/ansible | ||
| rst | ||
| .gitignore | ||
| .nojekyll | ||
| ansible_2_5.inv | ||
| ansible_2_6.inv | ||
| ansible_2_7.inv | ||
| ansible_2_8.inv | ||
| ansible_2_9.inv | ||
| jinja2.inv | ||
| keyword_desc.yml | ||
| Makefile | ||
| Makefile.sphinx | ||
| modules.js | ||
| python2.inv | ||
| python3.inv | ||
| README.md | ||
| requirements.txt | ||
| variables.dot | ||
Ansible documentation
This project hosts the source behind docs.ansible.com.
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.
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. For GitHub workflows and other information, see the GitHub Guides.