ansible/docsite
Brian Coca daa2c3a956 Merge pull request #9584 from Sgoettschkes/issue_docs_missing_ansible_sudo
Adding inventory parameter to documentation
2015-01-28 13:42:59 -05:00
..
_static multiple spelling error changes 2014-04-29 10:41:05 -04:00
_themes/srtd Add ebook link to docsite. 2014-11-04 16:48:44 -05:00
js/ansible
man
rst Merge pull request #9584 from Sgoettschkes/issue_docs_missing_ansible_sudo 2015-01-28 13:42:59 -05:00
.gitignore
.nojekyll
build-site.py Remove unused if/else clause, since it doesn't change anything 2014-09-21 15:18:53 +02:00
conf.py
favicon.ico Retinafy favicon.ico 2014-05-12 11:29:45 -04:00
Makefile Updating the module formatter to deal with the new repo structure. 2014-09-26 17:10:13 -04:00
modules.js
README.md
variables.dot Add the start of a graphviz doc to illustrate variable precedence graphically. 2014-05-09 17:13:01 -04:00

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 Michael 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"