b71a62283c
* Initial version of aos_ip_pool module * Add examples for IP Pool * Break down ip_pool into smaller function * Refactor do_load_resource * Add get_display_name_from_file * Add ‘src’ as an option to load ip pool from JSON file * Rename directory network/apstra to network/aos * Remove exception handling temporary * Remove all ‘Exception as XX’ to be python 2.4 compatible * Replace ‘== False’ with ‘is False’ for PEP8 Test * Update documentation to be Yaml compatible * Lisg all method imported from module_utils.aos * Refactor to align with collection.find() changes * Update examples by @gundalow’s recommendations * Update Documentation per @gundalow’s recommendations * Change the license per @gundalow recommendation * Add exception handling for get_aos_session * Change Auth format and add check_aos_version() to check minimum version * Add a check for minimum version * Refactor ‘src’ into ‘content’ to allow more options Remove get_display_name_from_file in aos.py Add content_to_dict in aos.py * Fix variable name in do_load_resource * Add mention of aos.py in module_utilities doc * Add try/except for import yaml * Add try/Except around main block of code and function * Refactor to auto detect content_format, update doc accordingly * Change create_new_ip_pool inputs * Remove unused import * Remove in_use as it’s never used * Fix doc format * Add version number in requirement doc |
9 years ago | |
|---|---|---|
| .. | ||
| _static | 9 years ago | |
| _themes/srtd | 9 years ago | |
| js/ansible | 9 years ago | |
| man | 9 years ago | |
| rst | 9 years ago | |
| rst_common | 9 years ago | |
| .gitignore | 9 years ago | |
| .nojekyll | 9 years ago | |
| Makefile | 9 years ago | |
| Makefile.sphinx | 9 years ago | |
| README.md | 9 years ago | |
| conf.py | 9 years ago | |
| favicon.ico | 9 years ago | |
| modules.js | 9 years ago | |
| variables.dot | 9 years ago | |
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/.
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"