ansible/docs/docsite
Toshio Kuratomi 6b639f147d
[stable-2.10] Update ansible doc formats (#71070) (#71111)
* Fix tty_ify bugs and refactor

* Move tty_ify() and supporting attributes to the DocCLI class as that's
  the only thing using it.
* Add unittest for the code.
* Fix a bug where the substitution macros can be detected when they are
  a part of another word.
* Add support for L(), R(), and HORIZONTALLINE which were added to the
  website docs many years ago.

* Update test/units/cli/test_doc.py

Co-authored-by: Matt Clay <matt@mystile.com>

Co-authored-by: Matt Clay <matt@mystile.com>
(cherry picked from commit fb144c4)

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2020-08-27 13:33:24 -05: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 [backport][docs][2.10]Docsbackportapalooza 8 (#71379) 2020-08-20 17:44:50 -05:00
js/ansible
rst [stable-2.10] Update ansible doc formats (#71070) (#71111) 2020-08-27 13:33:24 -05:00
.gitignore Docs backportapalooza 4 (#70875) 2020-07-28 17:38:17 -05:00
.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 Add the ansible_2_10 intersphinx reference. (#71028) (#71384) 2020-08-20 16:13:45 -05:00
ansible_2_9.inv Add the ansible_2_10 intersphinx reference. (#71028) (#71384) 2020-08-20 16:13:45 -05:00
ansible_2_10.inv Add the ansible_2_10 intersphinx reference. (#71028) (#71384) 2020-08-20 16:13:45 -05:00
collection-plugins.yml Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
jinja2.inv Intersphinx (#68090) 2020-03-06 14:16:35 -08:00
keyword_desc.yml Doc backportapalooza 2 (#70440) 2020-07-08 16:05:41 -05:00
Makefile Antsibull build format backport 71080 (#71285) 2020-08-27 12:53:29 -05:00
Makefile.sphinx Adds the ability to override the doc build output directory from the command line. (#36604) 2018-02-28 16:01:18 -08:00
modules.js
python2.inv Add a script to update the intersphinx inventory (#66646) 2020-01-22 17:20:02 -05:00
python3.inv Add the ansible_2_10 intersphinx reference. (#71028) (#71384) 2020-08-20 16:13:45 -05:00
README.md reduce docs/docsite/README to essential info (#64287) 2019-11-01 15:35:40 -05:00
requirements.txt Collections docs generation backport (#70515) 2020-07-20 14:28:35 -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.