cd6792a058
* WIP Partners guide for adding multiple modules * WIP * WIP * WIP * WIP * WIP * HACK * Revert hack * Brian's feedback * Remove squash notes * Minor tidyups * Unit & Integration tests (& minor tweaks) * Details about Unit tests * As we are about to feature freeze on Ansible 2.3 remove the notes about Ansible 2.4 and py2.4. * Module names should be in the singular * Scot & Dylan's feedback * 5 PRs at once. Remove FIXMEs * Formatting * How to use Git & GitHub * directories are in category & topic * Expectations of Module authors * Better wording for module author's responsibilities |
||
|---|---|---|
| .. | ||
| _static | ||
| _themes/srtd | ||
| js/ansible | ||
| man | ||
| rst | ||
| rst_common | ||
| .gitignore | ||
| .nojekyll | ||
| conf.py | ||
| favicon.ico | ||
| Makefile | ||
| Makefile.sphinx | ||
| modules.js | ||
| README.md | ||
| variables.dot | ||
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"