| 1 |
================================== |
| 2 |
Welcome to Invoke's documentation! |
| 3 |
================================== |
| 4 |
|
| 5 |
This site covers Invoke's conceptual & API documentation. For basic info on |
| 6 |
what Invoke is, including its public changelog & how the project is maintained, |
| 7 |
please see `the main project website <https://pyinvoke.org>`_. |
| 8 |
|
| 9 |
Getting started |
| 10 |
--------------- |
| 11 |
|
| 12 |
Many core ideas & API calls are explained in the tutorial/getting-started |
| 13 |
document: |
| 14 |
|
| 15 |
.. toctree:: |
| 16 |
:maxdepth: 2 |
| 17 |
|
| 18 |
getting-started |
| 19 |
|
| 20 |
|
| 21 |
The ``invoke`` CLI tool |
| 22 |
----------------------- |
| 23 |
|
| 24 |
Details on the CLI interface to Invoke, available core flags, and tab |
| 25 |
completion options. |
| 26 |
|
| 27 |
.. toctree:: |
| 28 |
invoke |
| 29 |
|
| 30 |
|
| 31 |
Concepts |
| 32 |
-------- |
| 33 |
|
| 34 |
Dig deeper into specific topics: |
| 35 |
|
| 36 |
.. toctree:: |
| 37 |
:maxdepth: 2 |
| 38 |
:glob: |
| 39 |
|
| 40 |
concepts/* |
| 41 |
|
| 42 |
.. _api: |
| 43 |
|
| 44 |
API |
| 45 |
--- |
| 46 |
|
| 47 |
Know what you're looking for & just need API details? View our auto-generated |
| 48 |
API documentation: |
| 49 |
|
| 50 |
.. toctree:: |
| 51 |
:maxdepth: 1 |
| 52 |
:glob: |
| 53 |
|
| 54 |
api/* |