You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite/rst/dev_guide
Sviatoslav Sydorenko e5609db342
[backport][2.9][PR #70446] Refactor Python API examples and docs (#70851)
* Add boilerplate snippet into `examples/`

It is a partial backport of #70224

(partially cherry picked from commit 4816bb4f43)

* Refactor Python API examples and docs

PR #70446: it's a follow-up for #70445.

It includes a merge of `examples/scripts/uptime.py` and a similar
code snippet from `docs/docsite/rst/dev_guide/developing_api.rst`.

This patch also changes the docs RST file to include contents of
the example file instead of holding a copy of a similar code.

(cherry picked from commit 20bb915092)
4 years ago
..
platforms AWS Guidelines: Make 'security_token' optional so that they can be run outside of CI (#66107) (#66136) 5 years ago
shared_snippets Clarify that GPLv3+ module_utils need core team approval (#56740) 6 years ago
style_guide Backport/2.9/docs (#64073) 5 years ago
testing/sanity [2.9] Backport /docs/docsite/rst: fix typos (#67650) 5 years ago
debugging.rst Add an example for the debugging module (#50197) 5 years ago
developing_api.rst [backport][2.9][PR #70446] Refactor Python API examples and docs (#70851) 4 years ago
developing_collections.rst Specify lowercase only for Galaxy namespaces (#67485) (#67503) 5 years ago
developing_core.rst removes last :doc: links in the dev guide (#58417) 5 years ago
developing_inventory.rst Backport/2.9/docs (#63247) 5 years ago
developing_locally.rst Update local module options (#57553) 6 years ago
developing_module_utilities.rst Docs: edits & expands module_utils & search path info in dev guide (#55931) 6 years ago
developing_modules.rst rewrite of the developer guide, part 1 (#45179) 6 years ago
developing_modules_best_practices.rst Sanitize URI module keys with no_log values (#70762) (#70821) 4 years ago
developing_modules_checklist.rst Clarify documentation on _info vs. _facts modules (#56611) 6 years ago
developing_modules_documenting.rst Allow no_log=False to silence the no_log warnings for module parameters (#64733) (#67439) 5 years ago
developing_modules_general.rst Update unit tests requirements/units.txt path (#61656) 5 years ago
developing_modules_general_aci.rst Backport/2.9/docs (#63247) 5 years ago
developing_modules_general_windows.rst Ansible.Basic - add required_by to module spec (#51407) 6 years ago
developing_modules_in_groups.rst removes last :doc: links in the dev guide (#58417) 5 years ago
developing_plugins.rst Backport/2.9/docs (#63247) 5 years ago
developing_program_flow_modules.rst Allow no_log=False to silence the no_log warnings for module parameters (#64733) (#67439) 5 years ago
developing_python_3.rst Fix typo in 'Ansible and Python 3' dev guide (#61226) 5 years ago
developing_rebasing.rst Update developing_rebasing.rst (#51650) 6 years ago
index.rst Backport/2.9/docs2 (#62805) 5 years ago
module_lifecycle.rst rewrite of the developer guide, part 1 (#45179) 6 years ago
overview_architecture.rst Docs: edits & expands module_utils & search path info in dev guide (#55931) 6 years ago
testing.rst removes last :doc: links in the dev guide (#58417) 5 years ago
testing_compile.rst Remove more docs build errors (#45364) 6 years ago
testing_documentation.rst Update docs references for ansible-test. (#60109) 5 years ago
testing_httptester.rst removes last :doc: links in the dev guide (#58417) 5 years ago
testing_integration.rst Elaborate on note that docker-priv only works with integration (#62035) 5 years ago
testing_integration_legacy.rst restores legacy testing file (#46095) 6 years ago
testing_pep8.rst Remove obsolete docs on pep8 sanity test. 5 years ago
testing_running_locally.rst removes last :doc: links in the dev guide (#58417) 5 years ago
testing_sanity.rst Docs: List of Sanity Tests (#52986) 6 years ago
testing_units.rst [2.9] Backport /docs/docsite/rst: fix typos (#67650) 5 years ago
testing_units_modules.rst removes last :doc: links in the dev guide (#58417) 5 years ago
testing_validate-modules.rst [stable-2.9] Fixes for validate-modules import handling. (#63932) 5 years ago