X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=docs%2Findex.rst;h=70f0c50b468e74e75015fb41ef2650b223cafdfc;hb=refs%2Ftags%2F0.4.0;hp=67d3fbe579f160ee6abee35918b6a9c97cba0ef5;hpb=17b45c65afac23a123e66834f93049a1c7e45201;p=osm%2FN2VC.git diff --git a/docs/index.rst b/docs/index.rst index 67d3fbe..70f0c50 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,62 +3,22 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -A Python library for Juju -========================= -Front Matter ------------- - -NOTE: There is no implementation here yet. It is simply a mocked out -design of what this library might look like. The design itself is not -complete. Comments on the design, good or bad, are welcomed. Use cases -are also appreciated as they will shape the design. - -The goal is to end up with a feature-full and officially supported -python library for Juju. - -The focus right now is on Juju 2+ only. - -Design Ideas ------------- - -* Present an object-oriented interface to all the features of the Juju - CLI -* Do as much as possible through the API so that the library can be used - without actually installing Juju - -Example Use Cases ------------------ - -Please add more! - -Simple bootstrap/deploy -+++++++++++++++++++++++ - -.. code:: python - - from juju import Juju - - juju = Juju() - lxd = juju.get_cloud('lxd') - controller = lxd.bootstrap('lxd-test') - model = controller.get_model('default') - - # We might want an async and blocking version of deploy()? - model.deploy('mediawiki-single') - - mediawiki = model.get_service('mediawiki') - mediawiki.expose() +.. include:: readme.rst Table of Contents ----------------- .. toctree:: - :maxdepth: 2 + :glob: + :maxdepth: 3 + + narrative/index + API Docs - api/modules +.. include:: changelog.rst Indices and tables