docs: set table-of-contents depth for reference

3 levels per doc should be enough for everything: any more probably means the doc should be split. Signed-off-by: Moritz Wanzenböck <[email protected]>
piraeusdatastore · Nov 27, 2024 · 09eb66a · 09eb66a
1 parent 2724d62
commit 09eb66a
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 7 deletions.
diff --git a/docs/reference/linstorcluster.md b/docs/reference/linstorcluster.md
@@ -465,7 +465,7 @@ spec:
 
 Reports the actual state of the cluster.
 
-## `.status.conditions`
+### `.status.conditions`
 
 The Operator reports the current state of the Cluster through a set of conditions. Conditions are identified by their
 `type`.

diff --git a/docs/reference/linstorsatellite.md b/docs/reference/linstorsatellite.md
@@ -44,7 +44,7 @@ Holds patches to apply to the Kubernetes resources. Inherited from matching
 
 Reports the actual state of the satellite.
 
-## `.status.conditions`
+### `.status.conditions`
 
 The Operator reports the current state of the LINSTOR Satellite through a set of conditions. Conditions are
 identified by their `type`.

diff --git a/docs/reference/linstorsatelliteconfiguration.md b/docs/reference/linstorsatelliteconfiguration.md
@@ -1,7 +1,3 @@
----
-toc_depth: 1
----
-
 # `LinstorSatelliteConfiguration`
 
 This resource controls the state of one or more LINSTOR® satellites.
@@ -357,7 +353,7 @@ spec:
 
 Reports the actual state of the cluster.
 
-## `.status.conditions`
+### `.status.conditions`
 
 The Operator reports the current state of the Satellite Configuration through a set of conditions. Conditions are
 identified by their `type`.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -121,6 +121,8 @@ markdown_extensions:
 - pymdownx.superfences
 - attr_list
 - md_in_html
+- toc:
+    toc_depth: 3
 - pymdownx.emoji:
     emoji_index: !!python/name:material.extensions.emoji.twemoji
     emoji_generator: !!python/name:material.extensions.emoji.to_svg