Commit graph

22 commits

Author SHA1 Message Date
EthanHur
0c855dc70b
Guide users to use ansible-runner ()
Update the docs to guide users to use `ansible-runner` instead of using Python API directly. In many use cases, executing Ansible playbooks are sufficient. In those use cases, `ansible-runner` is easier and much stable to use comparing with Python API, but there is no mention of it.
2020-08-03 10:15:37 -05:00
Sviatoslav Sydorenko
20bb915092
Refactor Python API examples and docs
PR : it's a follow-up for .

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.
2020-07-23 18:24:02 +02:00
Sviatoslav Sydorenko
8d97c8c222 Fix the internal Python API usage examples
Previous version initialized the `TaskQueueManager` after calling
`Play.load()` while advertising a way to inject a custom library
location path. This caused the tasks loader not to find any custom
modules because it was triggered before the path was actually added
to the module loader.

This patch changes the order of the operations to ensure that the
customized `context.CLIARGS` actually influences things.

Resolves https://github.com/ansible/ansible/issues/69758.
2020-07-03 10:44:54 +02:00
Alicia Cozine
3fc0694ffc removes last :doc: links in the dev guide () 2019-06-26 14:59:33 -04:00
Matt Martz
ab0985a83a
Update the example for API use to reflect new context object () 2019-01-21 11:21:06 -06:00
Simon Legner
33b9c880a4 Consistent typesetting of "GitHub" () 2019-01-15 14:53:04 +01:00
Ben Cornett
6229f89369 Fix spelling () 2018-10-28 15:55:41 -05:00
Alicia Cozine
9a76441c02
rewrite of the developer guide, part 1 ()
* rewrite of the developer guide, part 1
2018-09-07 08:57:36 -05:00
Andreas Olsson
1a11cecaef Prefer https:// links in the docs site
All the changed urls are availible by way of https://. Most of them
already redirect.
2018-08-01 08:20:40 -07:00
Brian Coca
a37f27a243 removed note from already removed 1.x api comment
fixes 
2018-07-11 11:55:57 -04:00
Ken Celenza
e476089bb9 spacing issue () 2018-05-09 10:08:59 +02:00
Matt Clay
c262dbfd30 Use https for links to ansible.com domains. 2018-04-23 11:33:56 -07:00
scottb
381359a8f8
Doc build warning/broken link clean-a-palooza ()
* Doc build warning/broken link clean-a-palooza, WIP commit 1.

* Fixed broken anchor

* Fixing additional broken links; converting from doc to ref.

* Fix anchor
2018-03-14 12:44:21 -07:00
Alexander Lex
19f92005b9 Update developing_api.rst ()
Fix for  and 
2018-03-08 10:48:48 +00:00
scottb
e7f9c5cc60 Copy edits and tweaks 2018-03-02 18:14:07 -05:00
Brian Coca
cf43e0d605 updated api example
- added many more comments
- removed very obsolete 1.x refs
2018-03-02 18:14:07 -05:00
Alexander Lex
59042d79f5 Update developing_api.rst to use correct inventory format for single explicit host ()
Fix for 
2018-01-16 09:57:11 -06:00
osLEccse
9c7d987395 Update developing_api.rst ()
Module path needs to be array instead of a string variable in order to work.
2018-01-09 11:23:01 +00:00
Matt Martz
d40eff720c Update API example for 2.4 2017-09-26 14:39:36 -04:00
Joseph Miguel
f88f4394c8 Update developing_api.rst ()
* Update developing_api.rst

* Update developing_api.rst

Edited.
2017-08-07 14:40:29 -04:00
John R Barker
7df31aaca1 Fix all RST errors for docs/docsite/rst ()
* developing_modules.rst is now in dev_guide, sync changes and delete the old version
* Cleaner RST & formatted code
* Tidyup roadmaps
* Link to repomerge
* Pull in abadger's fixes From https://github.com/ansible/ansible/compare/docs-code-block-fixes?expand=1
* Clean docsite/rst (apart from ROADMAP
2017-01-07 11:38:52 -08:00
Brian Coca
57f8b791d6 consolidated docs
point to new doc locations
removed non existing dirs
2017-01-06 09:16:59 -05:00
Renamed from docsite/rst/dev_guide/developing_api.rst (Browse further)