ansible/docsite
2016-01-04 20:02:01 -05:00
..
_static multiple spelling error changes 2014-04-29 10:41:05 -04:00
_themes/srtd udpate copyright date 2016-01-04 20:02:01 -05:00
js/ansible
man
rst minor grammar error was making me pull hair out 2016-01-04 13:52:06 -05:00
.gitignore
.nojekyll
build-site.py Make "make webdocs" compatible with Python 3 2015-12-08 12:00:53 -05:00
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 Retinafy favicon.ico 2014-05-12 11:29:45 -04:00
Makefile fixed css minification make target for docsite 2016-01-04 19:59:47 -05:00
modules.js
README.md Update README.md 2015-08-28 14:19:14 -04:00
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 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"