You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docsite
John Jarvis 318116f291 bad closing quote in footer 11 years ago
..
_static Use a docsite theme that is in source control, work in progress. 11 years ago
_themes/srtd bad closing quote in footer 11 years ago
js/ansible Remove extra "latest/" subdirectory in docs build structure. 11 years ago
man Remove extra "latest/" subdirectory in docs build structure. 11 years ago
rst Fix syntax of docsite anchors. 11 years ago
.gitignore Fix building of docsite 11 years ago
.nojekyll Subtree merge of ansible-docs 12 years ago
Makefile remove trailing whitespaces 11 years ago
README.md Use the sphinx_rtd_theme 11 years ago
ansible-logo.png Remove extra "latest/" subdirectory in docs build structure. 11 years ago
ansible_arch.jpg Remove extra "latest/" subdirectory in docs build structure. 11 years ago
ansible_arch2.jpg Remove extra "latest/" subdirectory in docs build structure. 11 years ago
build-site.py Remove extra "latest/" subdirectory in docs build structure. 11 years ago
conf.py Add copy of Sphinx RTD theme so we can modify if needed and everyone has a consistent copy. 11 years ago
github.png Remove extra "latest/" subdirectory in docs build structure. 11 years ago
modules.js Remove extra "latest/" subdirectory in docs build structure. 11 years ago

README.md

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"