You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite
Lars Kellogg-Stedman 220d224433 add note regarding {host,group}_vars directory lookup semantics (#48066)
* add note regarding {host,group}_vars directory lookup semantics

While the 'ansible-playbook' command will look for {host,group}_vars in
both the playbook and inventory directories, the 'ansible' command
will only look in the inventory directory. This follows from a close
reading of the documentation but isn't explicit and leads to the
perhaps unexpected result that you can run both commands with the same
configuration in the same directory and get different results.

This commit adds a note to the documentation making the difference in
behavior explicit.

Closes #48065

* incorporates bcoca feedback
6 years ago
..
_extensions Improving syntax highlighting in HTML docs (#42472) 6 years ago
_static Use updated pygments (#44846) 6 years ago
_themes This fixes a weird indentation issue in the menu (#45089) 6 years ago
js/ansible consolidated docs 8 years ago
rst add note regarding {host,group}_vars directory lookup semantics (#48066) 6 years ago
.gitignore Initial ansible-test sanity docs. (#26775) 7 years ago
.nojekyll consolidated docs 8 years ago
Makefile removes docs/api dir from .gitignore and Makefile (#47366) 6 years ago
Makefile.sphinx Adds the ability to override the doc build output directory from the command line. (#36604) 7 years ago
README.md docs: remove "make viewdocs" reference (#43860) 6 years ago
jinja2-2.9.7.inv Update the intersphinx cached indexes 7 years ago
keyword_desc.yml New keyword: ignore_unreachable (#43857) 6 years ago
modules.js consolidated docs 8 years ago
python2-2.7.13.inv Update the intersphinx cached indexes 7 years ago
python3-3.6.2.inv Update the intersphinx cached indexes 7 years ago
requirements.txt Move docsite requirements to the docs/docsite dir. (#46518) 6 years ago
variables.dot consolidated docs 8 years ago

README.md

Homepage and documentation source for Ansible

This project hosts the source behind docs.ansible.com

Contributions to the documentation are welcome. To make changes, submit a pull request that changes the reStructuredText files in the rst/ directory only, and the core team can do a docs build and push the static files.

If you wish to verify output from the markup such as link references, you may install sphinx and build the documentation by running make webdocs from the ansible/docsite directory.

To include module documentation you'll need to run make webdocs at the top level of the repository. The generated html files are in docsite/htmlout/.

To limit module documentation building to a specific module, run MODULES=NAME make webdocs instead. This should make testing module documentation syntax much faster. Instead of a single module, you can also specify a comma-separated list of modules. In order to skip building documentation for all modules, specify non-existing module name, for example MODULES=none make webdocs.

If you do not want to learn the reStructuredText format, you can also file issues about documentation problems on the Ansible GitHub project.

Note that module documentation can actually be generated from a DOCUMENTATION docstring 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"

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.