cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs/docsite: minor fixes in docs/docsite/README.md (#55356)

Browse source 
Added inline markup to important references. Fixed minor spelling error.

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
This commit is contained in:
James McClune 2019-04-16 12:46:01 -04:00 committed by Alicia Cozine
parent 395d471065
commit da1f86a40f
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/docsite/README.md
View file

@ -1,4 +1,4 @@
Homepage and documentation source for Ansible Homepage and Documentation Source for Ansible
============================================= =============================================
This project hosts the source behind [docs.ansible.com](https://docs.ansible.com/) This project hosts the source behind [docs.ansible.com](https://docs.ansible.com/)
@ -15,7 +15,7 @@ If you do not want to learn the reStructuredText format, you can also [file issu
Note that module documentation can actually be [generated from a DOCUMENTATION docstring][module-docs] in the modules directory, so corrections to modules written as such need to be made in the module source, rather than in docsite source. Note that module documentation can actually be [generated from a DOCUMENTATION docstring][module-docs] in the modules directory, so corrections to modules written as such need to be made in the module source, rather than in docsite source.
To install sphinx and the required theme, install pip and then "pip install sphinx sphinx_rtd_theme" To install sphinx and the required theme, install ``pip`` and then ``pip install sphinx sphinx_rtd_theme``
[file issues]: https://github.com/ansible/ansible/issues [file issues]: https://github.com/ansible/ansible/issues
[module-docs]: https://docs.ansible.com/developing_modules.html#documenting-your-module [module-docs]: https://docs.ansible.com/developing_modules.html#documenting-your-module
@ -23,7 +23,7 @@ To install sphinx and the required theme, install pip and then "pip install sphi
HEADERS 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: RST allows for arbitrary hierarchy for the headers, it will 'learn on the fly'. We also want a standard that all our documents can follow:
``` ```
########################## ##########################