Skip to content

Commit

Permalink
docs: add top-level intro and module-level intros (canonical#1320)
Browse files Browse the repository at this point in the history
Docs: Ops: Add top-level intro, clean up ops.module intro in light of
that, flesh out ops.pebble and ops.testing intros a bit more

https://warthogs.atlassian.net/browse/CHARMTECH-183

- [x] "home page" library reference
- [x] ops module
- [x] ops.main entry point
- [x] ops.pebble module
- [x] ops.testing module
  • Loading branch information
dimaqq authored and tonyandrewmeyer committed Oct 4, 2024
1 parent 713d8ca commit e35a74f
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@ integrations with other services, and making the charm easier to test.

.. _available on PyPI: https://pypi.org/project/ops/

The `ops` library is a Python framework for writing and testing Juju charms.

See more: `Charm SDK documentation <https://juju.is/docs/sdk>`_

The library provides:

- :ref:`ops_main_entry_point`, used to initialise and run your charm;
- :ref:`ops_module`, the API to respond to Juju events and manage the application;
- :ref:`ops_pebble_module`, the Pebble client, a low-level API for Kubernetes containers;
- :ref:`ops_testing_module`, the framework for unit testing charms in a simulated environment;

You can structure your charm however you like, but with the `ops` library, you
get a framework that promotes consistency and readability by following best
practices. It also helps you organise your code better by separating different
aspects of the charm, such as managing the application’s state, handling
integrations with other services, and making the charm easier to test.


.. toctree::
:hidden:
:maxdepth: 2
Expand All @@ -44,6 +62,8 @@ ops

.. _ops_main_entry_point:

.. _ops_main_entry_point:

ops.main entry point
--------------------

Expand Down

0 comments on commit e35a74f

Please sign in to comment.