docsite/README.md
b35fc42d
 Homepage and documentation source for Ansible
 =============================================
d6e4b1bf
 
d07a3b5e
 This project hosts the source behind [docs.ansible.com](http://docs.ansible.com/)
d6e4b1bf
 
 Contributions to the documentation are welcome.  To make changes, submit a pull request
b35fc42d
 that changes the reStructuredText files in the "rst/" directory only, and Michael can
c88c3a40
 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/.
d6e4b1bf
 
b35fc42d
 If you do not want to learn the reStructuredText format, you can also [file issues] about
 documentation problems on the Ansible GitHub project.
d6e4b1bf
 
b35fc42d
 Note that module documentation can actually be [generated from a DOCUMENTATION docstring][module-docs]
 in the modules directory, so corrections to modules written as such need to be made
 in the module source, rather than in docsite source.
d6e4b1bf
 
c88c3a40
 To install sphinx and the required theme, install pip and then "pip install sphinx sphinx_rtd_theme"
 
b35fc42d
 [file issues]: https://github.com/ansible/ansible/issues
d07a3b5e
 [module-docs]: http://docs.ansible.com/developing_modules.html#documenting-your-module
 
b35fc42d