ansible

Commit Graph

Author	SHA1	Message	Date
Toshio Kuratomi	3fba006207	Update bare exceptions to specify Exception. This will keep us from accidentally catching program-exiting exceptions like KeyboardInterupt and SystemExit.	6 years ago
Dag Wieers	310b0a2521	Docs: Make docsite rebuilds smarter/faster (#45062 ) * Make the following scripts idempotent so that we only have to rebuild changed docs, not all docs: * plugin_formatter * generate_man * dump_keywords.py * dump_config.py * testing_formatter.sh	6 years ago
Joseph Herlant	00a7ff7974	Move man pages generations to rst2man (#37861 )	7 years ago
Austin S. Hemmelgarn	d5ae9d1018	Fix build on Python 3.x by using sys.maxsize. (#30424 ) As outlined in https://docs.python.org/3.1/whatsnew/3.0.html#integers, sys.maxint doesn't exist anymore in Python 3.x because there is no maximum value for integers in Python 3.x. sys.maxsize is present in all versions of Python that are currently supported by Ansible, so use that instead as an arbitrarily large index value. Fixes the following build error when building with Python 3.x: make -j1 docs mkdir -p ./docs/man/man1/ ; \ PYTHONPATH=./lib docs/bin/generate_man.py --template-file=docs/templates/man.j2 --output-dir=docs/man/man1/ --output-format man lib/ansible/cli/.py Traceback (most recent call last): File "docs/bin/generate_man.py", line 253, in <module> allvars[cli_name] = opts_docs(cli_class_name, cli_name) File "docs/bin/generate_man.py", line 119, in opts_docs 'long_desc': trim_docstring(cli.__doc__), File "docs/bin/generate_man.py", line 34, in trim_docstring indent = sys.maxint AttributeError: module 'sys' has no attribute 'maxint' make: ** [Makefile:347: generate_asciidoc] Error 1	7 years ago
Adrian Likins	89c973445c	generate rst doc pages for command line tools (#27530 ) * let generate_man also gen rst pages for cli tools * make template-file, output-dir, output format cli options for generate_man * update main Makefile to use generate_man.py for docs (man pages and rst) * update vault docs that use :option: * Edits based on `6e34ea6242` and `a3afc78535` * add a optparse 'desc' to lib/ansible/cli/config.py The man page needs a short desc for the 'NAME' field which it gets from the option parse 'desc' value. Fixes building ansible-config man page. * add trim_docstring from pep257 to generate_man use pep258 docstring trim function to fix up any indention weirdness inherit to doc strings (ie, lines other than first line being indented. * Add refs to cli command actions To reference ansible-vaults --vault-id option, use: :option:`The link text here <ansible-vault --vault-id>` or: :option:`--vault-id <ansible-vault --vault-id>` To reference ansible-vault's 'encrypt' action, use: :ref:`The link text here <ansible_vault_encrypt>` or most of the time: :ref:`ansible-vault encrypt <ansible_vault_encrypt>`	7 years ago
Abhijeet Kasurde	b89cb95609	Fix spelling mistakes (comments only) (#25564 ) Original Author : klemens <ka7@github.com> Taking over previous PR as per https://github.com/ansible/ansible/pull/23644#issuecomment-307334525 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>	8 years ago
Toshio Kuratomi	0249918c7b	When outputting text to a file, convert to bytes first. Fixes #23137	8 years ago
Brian Coca	2a2e02aea4	.--. . .--. ---.. / .. ... / .- -. -. --- -.-- .. -. --.	8 years ago
Brian Coca	18a7a1ec31	added docs to CLI docstringsadded removed 'now intermediate build files' from repo adjusted gitignore	8 years ago

9 Commits (138fc11ee0ec3402885068eaa6362a42d1a46e7c)