ansible/docs/docsite
Brian Coca eaaf46a50d Revert "made example not fail"
This reverts commit 2c9543e0b7.

example won't fail but will prevent correct PATH from being set
using actual fix to deal with this corner case
2017-04-10 12:17:19 -04:00
..
_static consolidated docs 2017-01-06 09:16:59 -05:00
_themes/srtd Added Adobe DTM tracking. (#22889) 2017-03-22 19:37:01 -07:00
js/ansible consolidated docs 2017-01-06 09:16:59 -05:00
man consolidated docs 2017-01-06 09:16:59 -05:00
rst Revert "made example not fail" 2017-04-10 12:17:19 -04:00
rst_common consolidated docs 2017-01-06 09:16:59 -05:00
.gitignore consolidated docs 2017-01-06 09:16:59 -05:00
.nojekyll consolidated docs 2017-01-06 09:16:59 -05:00
conf.py PEP 8 indent cleanup. (#20800) 2017-01-29 07:28:53 +00:00
favicon.ico consolidated docs 2017-01-06 09:16:59 -05:00
keyword_desc.yml moved docs generation and templates to docs/ 2017-03-24 15:52:36 -04:00
Makefile moved docs generation and templates to docs/ 2017-03-24 15:52:36 -04:00
Makefile.sphinx Use correct path for docsite src (rst/) 2017-01-13 18:14:33 -05:00
modules.js consolidated docs 2017-01-06 09:16:59 -05:00
README.md consolidated docs 2017-01-06 09:16:59 -05:00
variables.dot consolidated docs 2017-01-06 09:16:59 -05: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"