ansible/docs/docsite
Felix Fontein a862ff2d43
Deprecation revisited (#69926)
* Allow to specify collection_name separately for deprecation.

* Use new functionality in Ansible.

* Use new functionality in tests.

* Update tagging/untagging functions.

* Update pylint deprecated sanity test.

* Update validate-modules. Missing are basic checks for version_added (validate semantic version format for collections).

* Improve version validation. Re-add version_added validation.

* Make sure collection names are added to return docs before schema validation.

* Extra checks to avoid crashes on bad data.

* Make C# module utils code work, and update/extend tests.

* Add changelog fragment.

* Stop extracting collection name from potentially tagged versions/dates.

* Simplify C# code.

* Update Windows modules docs.

* Forgot semicolons.
2020-06-09 15:21:19 -07:00
..
_extensions docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508) 2019-06-18 10:56:33 -05:00
_static Docs: improve anchors vs. header bar (#67244) 2020-02-11 13:16:26 -05:00
_themes/sphinx_rtd_theme Explain module docs loss for devel (#68369) 2020-03-25 13:55:05 -05:00
js/ansible
rst Deprecation revisited (#69926) 2020-06-09 15:21:19 -07:00
.gitignore
.nojekyll
ansible_2_5.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_6.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_7.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_8.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
ansible_2_9.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
jinja2.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
keyword_desc.yml note that environment is not good for secrets (#69618) 2020-05-28 15:24:32 -05:00
Makefile Turn on linkchecker in sphinx for documentation (#69590) 2020-05-29 11:48:53 -05:00
Makefile.sphinx
modules.js
python2.inv Add a script to update the intersphinx inventory (#66646) 2020-01-22 17:20:02 -05:00
python3.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
README.md reduce docs/docsite/README to essential info (#64287) 2019-11-01 15:35:40 -05:00
requirements.txt Move common build code from _build_helpers (#55986) 2019-07-16 12:19:01 -07:00
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.