ansible/docsite
2016-09-16 15:44:22 -04:00
..
_static multiple spelling error changes 2014-04-29 10:41:05 -04:00
_themes/srtd Add ad blocks back in (#17228) 2016-08-24 15:59:58 -04: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 Add note to explain inline comments can only begin with ; (#17607) 2016-09-16 15:44:22 -04:00
rst_common Mocate ansible_ssh_changes into a common directory 2016-05-24 11:37:04 -07:00
.gitignore Add *.min.css to docsite/.gitignore 2014-01-06 17:15:04 -06:00
.nojekyll Subtree merge of ansible-docs 2012-10-08 07:44:38 -04:00
build-site.py Make "make webdocs" compatible with Python 3 2015-12-08 12:00:53 -05:00
conf.py Added substitution definitions and references for version number, etc 2016-08-15 17:48:46 -07:00
favicon.ico Retinafy favicon.ico 2014-05-12 11:29:45 -04:00
Makefile now generate list of playbook ojbect directives 2016-02-25 16:48:37 -05:00
modules.js Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
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"