ansible/docs/docsite/rst/dev_guide/style_guide/index.rst

.. Ansible Style Guide documentation master file, created by
   sphinx-quickstart on Mon May 11 12:41:35 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. _style_guide:

*******************
Ansible Style Guide
*******************

Welcome to the Ansible Style Guide
==================================

Follow these guidelines to create clear, concise, useful community contributions and documentation. This guide helps us make the content on ansible.com consistent.

.. toctree::
  :maxdepth: 1

  basic_rules
  voice_style
  trademarks
  grammar_punctuation
  spelling_word_choice
  resources


.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`
Added style guide (#24310) * Added style guide * Fixed index 2017-05-04 20:25:13 +00:00			`.. Ansible Style Guide documentation master file, created by`
			`sphinx-quickstart on Mon May 11 12:41:35 2015.`
			`You can adapt this file completely to your liking, but it should at least`
			contain the root `toctree` directive.

Add docs about contributing to docs (#46481) * adds page on community contributions to docs 2018-10-24 15:14:01 +00:00			`.. _style_guide:`

Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 2018-09-11 16:51:47 +00:00			`*******************`
Added style guide (#24310) * Added style guide * Fixed index 2017-05-04 20:25:13 +00:00			`Ansible Style Guide`
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 2018-09-11 16:51:47 +00:00			`*******************`
Added style guide (#24310) * Added style guide * Fixed index 2017-05-04 20:25:13 +00:00
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 2018-09-11 16:51:47 +00:00			`Welcome to the Ansible Style Guide`
			`==================================`

			`Follow these guidelines to create clear, concise, useful community contributions and documentation. This guide helps us make the content on ansible.com consistent.`
Added style guide (#24310) * Added style guide * Fixed index 2017-05-04 20:25:13 +00:00
			`.. toctree::`
			`:maxdepth: 1`

			`basic_rules`
			`voice_style`
			`trademarks`
			`grammar_punctuation`
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 2018-09-11 16:51:47 +00:00			`spelling_word_choice`
			`resources`

Added style guide (#24310) * Added style guide * Fixed index 2017-05-04 20:25:13 +00:00
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 2018-09-11 16:51:47 +00:00			`.. Indices and tables`
			`.. ==================`
Added style guide (#24310) * Added style guide * Fixed index 2017-05-04 20:25:13 +00:00
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 2018-09-11 16:51:47 +00:00			.. * :ref:`genindex`
			.. * :ref:`modindex`
Added style guide (#24310) * Added style guide * Fixed index 2017-05-04 20:25:13 +00:00			.. * :ref:`search`