From 84a5f608c2a165adb3288ad1e8c8c1f4d81922a0 Mon Sep 17 00:00:00 2001 From: Dima Tisnek Date: Tue, 20 Aug 2024 17:53:18 +0900 Subject: [PATCH] try to fix things --- docs/custom_conf.py | 1 + docs/index.rst | 25 +++++++++++-------------- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/docs/custom_conf.py b/docs/custom_conf.py index 492ad571c..48be27e2a 100644 --- a/docs/custom_conf.py +++ b/docs/custom_conf.py @@ -188,6 +188,7 @@ def _compute_navigation_tree(context): 'canonical.related-links', 'canonical.custom-rst-roles', 'canonical.terminal-output', + 'canonical.filtered-toc', 'notfound.extension', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', diff --git a/docs/index.rst b/docs/index.rst index 70e6f14ef..5dad7b6db 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,26 +18,23 @@ The `ops` library provides powerful constructs for charm developers: .. toctree:: :maxdepth: 2 - :titlesonly: - - ops_main - ops_module - ops_pebble - ops_testing +.. + .. filtered-toctree: + :maxdepth: 2 + :filter-this-out:guess-what-name-"self"-is .. _ops_main: - -The ops.main Entry Point +ops.main Entry Point ======================== -text text text +.. automodule:: ops.main -.. _ops_module: +.. _ops: -The ops Module +ops Module ============== Quick Start Example @@ -70,12 +67,11 @@ Here’s a simple charm example using the `ops` library: main ----------- -.. automodule:: ops.main .. _ops_pebble: -The ops.pebble Module +ops.pebble Module ===================== Quick Pebble Example @@ -115,7 +111,7 @@ For a Kubernetes charm using Pebble: .. _ops_testing: -The ops.testing Module +ops.testing Module ====================== Testing Example @@ -144,3 +140,4 @@ Indices * :ref:`genindex` * :ref:`modindex` * :ref:`search` +