X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FN2VC.git;a=blobdiff_plain;f=modules%2Flibjuju%2Fdocs%2Freadme.rst;h=87666d0ba3c9781881f2448ba075911b3bc74e6f;hp=886550d0c151f51f5bed30eb64b84a0d5c68eaff;hb=93a3db12e79d8e35ab8ca9a518a56631d8fd0707;hpb=c3e6c2ec9a1fddfc8e9bd31509b366e633b6d99e;ds=sidebyside diff --git a/modules/libjuju/docs/readme.rst b/modules/libjuju/docs/readme.rst index 886550d..87666d0 100644 --- a/modules/libjuju/docs/readme.rst +++ b/modules/libjuju/docs/readme.rst @@ -38,10 +38,7 @@ Quickstart ---------- Here's a simple example that shows basic usage of the library. The example connects to the currently active Juju model, deploys a single unit of the -ubuntu charm, then exits. - -More examples can be found in the `examples/` directory of the source tree, -and in the documentation. +ubuntu charm, then exits: .. code:: python @@ -95,3 +92,12 @@ and in the documentation. if __name__ == '__main__': main() + + +More examples can be found in the docs, as well as in the ``examples/`` +directory of the source tree which can be run using ``tox``. For +example, to run ``examples/connect_current_model.py``, use: + +.. code:: bash + + tox -e example -- examples/connect_current_model.py