toc rework

2026-06-21 00:46:51 +08:00 · 2022-12-27 20:18:00 +01:00 · 2022-12-27 20:18:00 +01:00 · e27d754ed0
commit e27d754ed0
parent f176e96a47
16 changed files with 49 additions and 28 deletions
--- a/docs/conf.py
+++ b/docs/conf.py
@ -8,7 +8,7 @@

 import sphinx_rtd_theme

-project = 'Datadog\'s Go Observability Guide'
+project = 'go-profiler-notes'
 copyright = '2022, Datadog'
 author = 'Felix Geisendörfer, Nick Ripley'

@ -36,6 +36,8 @@ html_theme = 'sphinx_rtd_theme'
 html_theme_options = {
    'style_nav_header_background': '#5C2EA0',
    'collapse_navigation': False,
+    'navigation_depth': 5,
+    'includehidden': False,
 }
 html_static_path = ['_static']
 html_css_files = ['css/custom.css']
--- a/docs/index.rst
+++ b/docs/index.rst
@ -1,4 +1,4 @@
-Go Profiler Notes
+go-profiler-notes
 =================

 Formerly known as "go-profiler-notes", this guide contains in-depth information
@ -7,8 +7,27 @@ metrics, heap debugging as well as userland metrics and distributed tracing will
 be covered as well.

 .. toctree::
-   :maxdepth: 3
-   :caption: Contents:
+   :hidden:

-   about
   profiling/index
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Mental Model for Go
+
+   mental-model-for-go/goroutine-scheduler
+   mental-model-for-go/garbage-collector
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Profilers
+
+   profiling/cpu-profiler
+   profiling/memory-profiler
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Misc
+
+   misc/stack-traces
+   misc/pprof
--- a/docs/mental-model-for-go/garbage-collector.rst
+++ b/docs/mental-model-for-go/garbage-collector.rst
@ -0,0 +1,2 @@
+Garbage Collector
+=================
--- a/docs/mental-model-for-go/goroutine-scheduler.rst
+++ b/docs/mental-model-for-go/goroutine-scheduler.rst
@ -0,0 +1,2 @@
+Goroutine Scheduler
+===================
--- a/docs/mental-model-for-go/index.rst
+++ b/docs/mental-model-for-go/index.rst
@ -0,0 +1,9 @@
+Mental Model for Go
+===================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   goroutine-scheduler
+   garbage-collector
--- a/docs/misc/pprof.rst
+++ b/docs/misc/pprof.rst
@ -0,0 +1,2 @@
+pprof Tool and Format
+=====================
--- a/docs/misc/stack-traces.rst
+++ b/docs/misc/stack-traces.rst
@ -0,0 +1,4 @@
+Stack Traces
+============
+
+
--- a/docs/profiling/builtin-profilers/index.rst
+++ b/docs/profiling/builtin-profilers/index.rst
@ -1,9 +0,0 @@
-Builtin Profilers
-=================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-   cpu-profiler
-   memory-profiler
--- a/docs/profiling/builtin-profilers/cpu-profiler-net-http-pprof.go
+++ b/docs/profiling/builtin-profilers/cpu-profiler-net-http-pprof.go
--- a/docs/profiling/builtin-profilers/cpu-profiler-start-stop.go
+++ b/docs/profiling/builtin-profilers/cpu-profiler-start-stop.go
--- a/docs/profiling/builtin-profilers/cpu-profiler-trace.go
+++ b/docs/profiling/builtin-profilers/cpu-profiler-trace.go
--- a/docs/profiling/builtin-profilers/cpu-profiler.rst
+++ b/docs/profiling/builtin-profilers/cpu-profiler.rst
--- a/docs/profiling/index.rst
+++ b/docs/profiling/index.rst
@ -1,8 +1,8 @@
-Profiling
+Profilers
 =========

 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1

-   builtin-profilers/index
+   cpu-profiler
+   memory-profiler
--- a/docs/profiling/builtin-profilers/memory-profiler-gc.go
+++ b/docs/profiling/builtin-profilers/memory-profiler-gc.go
--- a/docs/profiling/builtin-profilers/memory-profiler.rst
+++ b/docs/profiling/builtin-profilers/memory-profiler.rst
--- a/test/index.html
+++ b/test/index.html
@ -1,10 +0,0 @@
-<!doctype html>
-<html lang=en>
-<head>
-<meta charset=utf-8>
-<title>blah</title>
-</head>
-<body>
-<p>I'm the content</p>
-</body>
-</html>