try to fix things

canonical · Aug 20, 2024 · 84a5f60 · 84a5f60
1 parent 1b1f6ce
commit 84a5f60
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 14 deletions.
diff --git 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
@@ -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`
+