diff --git a/docs/index.rst b/docs/index.rst index 24f0a7f4b..8ac0abcee 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,7 +9,7 @@ The library (`available on PyPI`_) provides: - :ref:`ops_module`, the API to respond to Juju events and manage the application; - :ref:`ops_main_entry_point`, used to initialise and run your charm; -- :ref:`ops_pebble_module`, the Pebble client, a low-level API for Kubernetes containers; +- :doc:`ops.pebble `, the Pebble client, a low-level API for Kubernetes containers; - the APIs for unit testing charms in a simulated environment: - :doc:`State-transition testing `. This is the @@ -30,6 +30,7 @@ integrations with other services, and making the charm easier to test. :maxdepth: 2 self + pebble state-transition-testing harness @@ -56,15 +57,6 @@ legacy main module .. automodule:: ops.main :noindex: -.. _ops_pebble_module: - -ops.pebble ----------- - -.. automodule:: ops.pebble - -.. _ops_testing_module: - Indices ======= diff --git a/docs/pebble.rst b/docs/pebble.rst new file mode 100644 index 000000000..b5f6e8180 --- /dev/null +++ b/docs/pebble.rst @@ -0,0 +1,6 @@ +.. _ops_pebble_module: + +Pebble client +============= + +.. automodule:: ops.pebble diff --git a/ops/__init__.py b/ops/__init__.py index b4c05f3f2..770a97f55 100644 --- a/ops/__init__.py +++ b/ops/__init__.py @@ -14,7 +14,7 @@ """The API to respond to Juju events and manage the application. -This module provides core features to your charm, including: +This API provides core features to your charm, including: - :class:`~ops.CharmBase`, the base class for charms and :class:`~ops.Object`, the base class for charm libraries.