d6b40c935f
* Fixes passlib example in FAQ to reduce the number of rounds to 5000 As stated in issue #15326, the default number for glibc is 5000, where the default for passlib is 656000. I actually found out when I spend few hours trying to understand why ansible was taking almost x3 the time to run a playbook when using a user with sudo and password (comparared to sudo with NOPASSWD set). Well, it was because the user was created using ansible and the passlib example found in the docs' FAQ. Reducing the numbers of rounds to 5000 will ensure a better experience with ansible for newcomers when using sudo with a password. * Fixes passlib example in FAQ to reflect the API changes in passlib 1.7 Method encrypt() was deprecated in 1.7 and renamed to hash(), which happened almost a year ago. https://passlib.readthedocs.io/en/stable/lib/passlib.ifc.html#passlib.ifc.PasswordHash.encrypt |
8 years ago | |
---|---|---|
.. | ||
_static | 8 years ago | |
_themes/srtd | 8 years ago | |
js/ansible | 8 years ago | |
man | 8 years ago | |
rst | 8 years ago | |
rst_common | 8 years ago | |
.gitignore | 8 years ago | |
.nojekyll | 8 years ago | |
Makefile | 8 years ago | |
Makefile.sphinx | 8 years ago | |
README.md | 8 years ago | |
conf.py | 8 years ago | |
favicon.ico | 8 years ago | |
modules.js | 8 years ago | |
variables.dot | 8 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"