ansible/docsite/README.md

29 lines
1.4 KiB
Markdown
Raw Normal View History

Homepage and documentation source for Ansible
=============================================
2012-10-08 13:44:38 +02:00
This project hosts the source behind [ansibleworks.com/docs](http://www.ansibleworks.com/docs/)
2012-10-08 13:44:38 +02:00
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
2013-12-24 23:23:38 +01:00
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/.
2012-10-08 13:44:38 +02:00
If you do not want to learn the reStructuredText format, you can also [file issues] about
documentation problems on the Ansible GitHub project.
2012-10-08 13:44:38 +02:00
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.
2012-10-08 13:44:38 +02:00
2013-12-24 23:23:38 +01:00
To install sphinx and the required theme, install pip and then "pip install sphinx sphinx_rtd_theme"
[file issues]: https://github.com/ansible/ansible/issues
[module-docs]: http://www.ansibleworks.com/docs/developing_modules.html#documenting-your-module