ansible/docsite
2014-05-03 17:59:50 +02:00
..
_static
_themes/srtd Updated footer date and adding in misc. file generated by earlier doc update 2014-02-12 16:14:41 -06:00
js/ansible
man
rst fixed typos found by RETF rules in RST files 2014-05-03 17:59:50 +02:00
.gitignore
.nojekyll
build-site.py Fix path to index.html when launching browser 2014-02-17 12:00:41 +01:00
conf.py
favicon.ico
Makefile
modules.js
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 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"