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 be28e98cf2
[backport][2.10][PR #70446] Refactor Python API examples and docs (#70850)
* 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 [backport][2.10]Docs backportapalooza3 (#70695) 4 years ago
shared_snippets Clarify that GPLv3+ module_utils need core team approval (#56740) 6 years ago
style_guide added documentation for R() (#69832) 5 years ago
testing/sanity validate ansible-base's and collections runtime.yml (#69742) 5 years ago
debugging.rst Correct debugging modules documentation (#69245) 5 years ago
developing_api.rst [backport][2.10][PR #70446] Refactor Python API examples and docs (#70850) 4 years ago
developing_collections.rst Docs backportapalooza 4 (#70875) 4 years ago
developing_core.rst removes last :doc: links in the dev guide (#58417) 6 years ago
developing_inventory.rst Docs backportapalooza 4 (#70875) 4 years ago
developing_locally.rst Docs backportapalooza 4 (#70875) 4 years ago
developing_module_utilities.rst fixed some broken links (#66182) 5 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) (#70820) 4 years ago
developing_modules_checklist.rst This was changed to python 2.7 but should have remained python 2.6 (#66836) 5 years ago
developing_modules_documenting.rst Doc backportapalooza 2 (#70440) 4 years ago
developing_modules_general.rst [backport][2.10]Docs backportapalooza3 (#70695) 4 years ago
developing_modules_general_aci.rst remove build errors including guess (#69711) 5 years ago
developing_modules_general_windows.rst Docs backportapalooza 4 (#70875) 4 years ago
developing_modules_in_groups.rst [backport][2.10]Docs backportapalooza3 (#70695) 4 years ago
developing_plugins.rst Update inventory caching documentation (#69100) 5 years ago
developing_program_flow_modules.rst doc: explain default "required" value for argument_spec (#68678) 5 years ago
developing_python_3.rst Update developing_python_3.rst (#66249) 5 years ago
developing_rebasing.rst Update developing_rebasing.rst (#51650) 6 years ago
index.rst How to contribute to Ansible maintained collections (#69202) 5 years ago
migrating_roles.rst remove build errors including guess (#69711) 5 years ago
module_lifecycle.rst Document the ability to deprecate by date (#69833) 5 years ago
overview_architecture.rst Docs: edits & expands module_utils & search path info in dev guide (#55931) 6 years ago
testing.rst Update testing collections to mention ansible-base versions (#69805) 5 years ago
testing_compile.rst Extend dev guide for collection testing and collection hacking (#68899) 5 years ago
testing_documentation.rst dev_guide: Correct path to ansible-test requirements files (#66626) 5 years ago
testing_httptester.rst removes last :doc: links in the dev guide (#58417) 6 years ago
testing_integration.rst [backport][2.10]Docs backportapalooza3 (#70695) 4 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 fixes link, makes intrapage TOC local (#67664) 5 years ago
testing_sanity.rst Dev guide: add notes about different image types for integration and unit/sanity tests (#68663) 5 years ago
testing_units.rst Dev guide: add notes about different image types for integration and unit/sanity tests (#68663) 5 years ago
testing_units_modules.rst fixes import paths for ansible unit testing (#65775) 5 years ago
testing_validate-modules.rst starting metadata sunset (#69454) 5 years ago