mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-30 08:31:28 -07:00
inventory plugin docs (#42022)
* inventory plugin docs * added set options * minor wording and formatting fixes * changed headers to std as per #35520, also added to main readme * unified inventory plugin devel, referenced from generic plugin dev * fixed typos and update as per feedback
This commit is contained in:
parent
133b70ff45
commit
475abc0af7
5 changed files with 308 additions and 59 deletions
|
@ -19,3 +19,33 @@ To install sphinx and the required theme, install pip and then "pip install sphi
|
|||
|
||||
[file issues]: https://github.com/ansible/ansible/issues
|
||||
[module-docs]: https://docs.ansible.com/developing_modules.html#documenting-your-module
|
||||
|
||||
HEADERS
|
||||
=======
|
||||
|
||||
RST allows for arbitrary hierchy for the headers, it will 'learn on the fly' but we want a standard so all our documents can follow:
|
||||
|
||||
```
|
||||
##########################
|
||||
# with overline, for parts
|
||||
##########################
|
||||
|
||||
*****************************
|
||||
* with overline, for chapters
|
||||
*****************************
|
||||
|
||||
=, for sections
|
||||
===============
|
||||
|
||||
-, for subsections
|
||||
------------------
|
||||
|
||||
^, for sub-subsections
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
", for paragraphs
|
||||
"""""""""""""""""
|
||||
|
||||
```
|
||||
|
||||
We do have pages littered with ```````` headers, but those should be removed for one of the above.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue