e4cd899363
* Adapt azure_rm_resource_group to azure 2.0.0 + azure Cli support * Fix exceptions in Azure ARM plugins * update azure_rm_networkinterface documention to reflect required params * change state param to not required for docs in azure_rm_subnet * fix import to reflect azure==2.0.0 changes * add aliases and fix docs for azure_rm_storageblob * add resource_group_name alias to azure_rm_storageaccount_facts * fix import bug due to change in azure==2.0.0 * fix args bug and enum modules issue * update docs to reflect azure==2.0.0 * pin management clients to a specific api_version * update docs to reflect the new azure-ansible-base python package * add fallback for older api resource group listing * rework azure dependencies installation * refactor path joining to a cross-plat solution |
7 years ago | |
|---|---|---|
| .. | ||
| _static | ||
| _themes/srtd | ||
| js/ansible | ||
| man | ||
| rst | ||
| rst_common | ||
| .gitignore | ||
| .nojekyll | ||
| Makefile | ||
| Makefile.sphinx | ||
| README.md | ||
| favicon.ico | ||
| jinja2-2.9.6.inv | ||
| keyword_desc.yml | ||
| modules.js | ||
| python2-2.7.13.inv | ||
| python3-3.6.1.inv | ||
| variables.dot | ||
README.md
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/.
To limit module documentation building to a specific module, run MODULES=NAME make webdocs instead. This should make testing module documentation syntax much
faster. Instead of a single module, you can also specify a comma-separated list
of modules. In order to skip building documentation for all modules, specify
non-existing module name, for example MODULES=none make webdocs.
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"