ansible/docsite
2014-01-02 20:16:19 -05:00
..
_static Use a docsite theme that is in source control, work in progress. 2013-12-24 14:10:49 -05:00
_themes/srtd bad closing quote in footer 2014-01-02 20:16:19 -05:00
js/ansible Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
man Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
rst Fix syntax of docsite anchors. 2014-01-02 17:37:48 -05:00
.gitignore Fix building of docsite 2013-10-15 16:21:19 +02:00
.nojekyll Subtree merge of ansible-docs 2012-10-08 07:44:38 -04:00
ansible-logo.png Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
ansible_arch.jpg Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
ansible_arch2.jpg Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
build-site.py Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
conf.py Add copy of Sphinx RTD theme so we can modify if needed and everyone has a consistent copy. 2013-12-24 18:10:19 -05:00
github.png Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
Makefile remove trailing whitespaces 2013-12-25 21:19:00 +02:00
modules.js Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
README.md Use the sphinx_rtd_theme 2013-12-24 17:23:38 -05:00

Homepage and documentation source for Ansible

This project hosts the source behind ansibleworks.com/docs

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"