ansible/docsite
Sandra Wills ce0cedc4a7 Merge pull request #12764 from docschick/docschick-fixes
vault and variables best practices info added, edited, and referenced
2015-10-15 10:01:06 -04:00
..
_static
_themes/srtd Merge pull request #11932 from jlmitch5/update_doc_ads 2015-08-11 16:43:11 -04:00
js/ansible
man
rst Merge pull request #12764 from docschick/docschick-fixes 2015-10-15 10:01:06 -04:00
.gitignore
.nojekyll
build-site.py
conf.py enabled yaml highlighting globally, made specific emphasis for blocks in playbooks_blocks docs 2015-08-04 19:13:09 -04:00
favicon.ico
Makefile
modules.js
README.md Update README.md 2015-08-28 14:19:14 -04:00
variables.dot

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 viewdocs 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/.

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"