Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: move Pebble to a separate page #1392

Merged
merged 3 commits into from
Sep 26, 2024
Merged

docs: move Pebble to a separate page #1392

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2dfbdd3
Move Pebble to a separate page.
tonyandrewmeyer Sep 26, 2024
b8cd483
Add the new Pebble page.
tonyandrewmeyer Sep 26, 2024
7a0b3c2
Adjust page heading, per review.
tonyandrewmeyer Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 </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 </state-transition-testing>`. This is the
Expand All @@ -30,6 +30,7 @@ integrations with other services, and making the charm easier to test.
:maxdepth: 2

self
pebble
state-transition-testing
harness

Expand All @@ -56,15 +57,6 @@ legacy main module
.. automodule:: ops.main
:noindex:

.. _ops_pebble_module:

ops.pebble
----------

.. automodule:: ops.pebble

.. _ops_testing_module:


Indices
=======
Expand Down
6 changes: 6 additions & 0 deletions docs/pebble.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _ops_pebble_module:

ops.pebble
tonyandrewmeyer marked this conversation as resolved.
Show resolved Hide resolved
==========

.. automodule:: ops.pebble
2 changes: 1 addition & 1 deletion ops/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading