From 20786fa051c7b7b49a78ee1434382e1a487bdce3 Mon Sep 17 00:00:00 2001 From: Tony Meyer Date: Fri, 4 Oct 2024 18:49:27 +1300 Subject: [PATCH] Fix bad rebase. --- docs/index.rst | 26 -------------------------- 1 file changed, 26 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 687c0c258..8ac0abcee 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,30 +25,6 @@ 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 `_ - -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; -- the APIs for unit testing charms in a simulated environment: - - - :doc:`State-transition testing `. This is the - recommended approach (it was previously known as 'Scenario'). - - :doc:`Harness `. This is a deprecated framework, and has issues, - particularly with resetting the charm state between Juju events. - -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. - -.. _available on PyPI: https://pypi.org/project/ops/ - .. toctree:: :hidden: :maxdepth: 2 @@ -68,8 +44,6 @@ ops .. _ops_main_entry_point: -.. _ops_main_entry_point: - ops.main entry point --------------------