5f6db0e164
- become constants inherit existing sudo/su ones - become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group - changed method signatures as privlege escalation is collapsed to become - added tests for su and become, diabled su for lack of support in local.py - updated playbook,play and task objects to become - added become to runner - added whoami test for become/sudo/su - added home override dir for plugins - removed useless method from ask pass - forced become pass to always be string also uses to_bytes - fixed fakerunner for tests - corrected reference in synchronize action plugin - added pfexec (needs testing) - removed unused sudo/su in runner init - removed deprecated info - updated pe tests to allow to run under sudo and not need root - normalized become options into a funciton to avoid duplication and inconsistencies - pushed suppored list to connection classs property - updated all connection plugins to latest 'become' pe - includes fixes from feedback (including typos) - added draft docs - stub of become_exe, leaving for future v2 fixes |
10 years ago | |
|---|---|---|
| .. | ||
| _static | 11 years ago | |
| _themes/srtd | 10 years ago | |
| js/ansible | 11 years ago | |
| man | 11 years ago | |
| rst | 10 years ago | |
| .gitignore | 11 years ago | |
| .nojekyll | 12 years ago | |
| Makefile | 10 years ago | |
| README.md | 11 years ago | |
| build-site.py | 10 years ago | |
| conf.py | 11 years ago | |
| favicon.ico | 11 years ago | |
| modules.js | 11 years ago | |
| variables.dot | 11 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 Michael 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"