From e27d754ed05ba36c1e2747b4cc7f9e4d7eec13b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20Geisend=C3=B6rfer?= Date: Tue, 27 Dec 2022 20:18:00 +0100 Subject: [PATCH] toc rework --- docs/conf.py | 4 ++- docs/index.rst | 27 ++++++++++++++++--- .../mental-model-for-go/garbage-collector.rst | 2 ++ .../goroutine-scheduler.rst | 2 ++ docs/mental-model-for-go/index.rst | 9 +++++++ docs/misc/pprof.rst | 2 ++ docs/misc/stack-traces.rst | 4 +++ docs/profiling/builtin-profilers/index.rst | 9 ------- .../cpu-profiler-net-http-pprof.go | 0 .../cpu-profiler-start-stop.go | 0 .../cpu-profiler-trace.go | 0 .../{builtin-profilers => }/cpu-profiler.rst | 0 docs/profiling/index.rst | 8 +++--- .../memory-profiler-gc.go | 0 .../memory-profiler.rst | 0 test/index.html | 10 ------- 16 files changed, 49 insertions(+), 28 deletions(-) create mode 100644 docs/mental-model-for-go/garbage-collector.rst create mode 100644 docs/mental-model-for-go/goroutine-scheduler.rst create mode 100644 docs/mental-model-for-go/index.rst create mode 100644 docs/misc/pprof.rst create mode 100644 docs/misc/stack-traces.rst delete mode 100644 docs/profiling/builtin-profilers/index.rst rename docs/profiling/{builtin-profilers => }/cpu-profiler-net-http-pprof.go (100%) rename docs/profiling/{builtin-profilers => }/cpu-profiler-start-stop.go (100%) rename docs/profiling/{builtin-profilers => }/cpu-profiler-trace.go (100%) rename docs/profiling/{builtin-profilers => }/cpu-profiler.rst (100%) rename docs/profiling/{builtin-profilers => }/memory-profiler-gc.go (100%) rename docs/profiling/{builtin-profilers => }/memory-profiler.rst (100%) delete mode 100644 test/index.html diff --git a/docs/conf.py b/docs/conf.py index ed23c5c..24e5ff5 100644 --- 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'] diff --git a/docs/index.rst b/docs/index.rst index 8b0acf1..97d8928 100644 --- 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 diff --git a/docs/mental-model-for-go/garbage-collector.rst b/docs/mental-model-for-go/garbage-collector.rst new file mode 100644 index 0000000..0e3b2cc --- /dev/null +++ b/docs/mental-model-for-go/garbage-collector.rst @@ -0,0 +1,2 @@ +Garbage Collector +================= diff --git a/docs/mental-model-for-go/goroutine-scheduler.rst b/docs/mental-model-for-go/goroutine-scheduler.rst new file mode 100644 index 0000000..757f7fa --- /dev/null +++ b/docs/mental-model-for-go/goroutine-scheduler.rst @@ -0,0 +1,2 @@ +Goroutine Scheduler +=================== diff --git a/docs/mental-model-for-go/index.rst b/docs/mental-model-for-go/index.rst new file mode 100644 index 0000000..ab1d2d7 --- /dev/null +++ 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 diff --git a/docs/misc/pprof.rst b/docs/misc/pprof.rst new file mode 100644 index 0000000..b6240c7 --- /dev/null +++ b/docs/misc/pprof.rst @@ -0,0 +1,2 @@ +pprof Tool and Format +===================== diff --git a/docs/misc/stack-traces.rst b/docs/misc/stack-traces.rst new file mode 100644 index 0000000..034597d --- /dev/null +++ b/docs/misc/stack-traces.rst @@ -0,0 +1,4 @@ +Stack Traces +============ + + diff --git a/docs/profiling/builtin-profilers/index.rst b/docs/profiling/builtin-profilers/index.rst deleted file mode 100644 index 2eac559..0000000 --- a/docs/profiling/builtin-profilers/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -Builtin Profilers -================= - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - cpu-profiler - memory-profiler diff --git a/docs/profiling/builtin-profilers/cpu-profiler-net-http-pprof.go b/docs/profiling/cpu-profiler-net-http-pprof.go similarity index 100% rename from docs/profiling/builtin-profilers/cpu-profiler-net-http-pprof.go rename to docs/profiling/cpu-profiler-net-http-pprof.go diff --git a/docs/profiling/builtin-profilers/cpu-profiler-start-stop.go b/docs/profiling/cpu-profiler-start-stop.go similarity index 100% rename from docs/profiling/builtin-profilers/cpu-profiler-start-stop.go rename to docs/profiling/cpu-profiler-start-stop.go diff --git a/docs/profiling/builtin-profilers/cpu-profiler-trace.go b/docs/profiling/cpu-profiler-trace.go similarity index 100% rename from docs/profiling/builtin-profilers/cpu-profiler-trace.go rename to docs/profiling/cpu-profiler-trace.go diff --git a/docs/profiling/builtin-profilers/cpu-profiler.rst b/docs/profiling/cpu-profiler.rst similarity index 100% rename from docs/profiling/builtin-profilers/cpu-profiler.rst rename to docs/profiling/cpu-profiler.rst diff --git a/docs/profiling/index.rst b/docs/profiling/index.rst index 6497027..bb72d78 100644 --- 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 diff --git a/docs/profiling/builtin-profilers/memory-profiler-gc.go b/docs/profiling/memory-profiler-gc.go similarity index 100% rename from docs/profiling/builtin-profilers/memory-profiler-gc.go rename to docs/profiling/memory-profiler-gc.go diff --git a/docs/profiling/builtin-profilers/memory-profiler.rst b/docs/profiling/memory-profiler.rst similarity index 100% rename from docs/profiling/builtin-profilers/memory-profiler.rst rename to docs/profiling/memory-profiler.rst diff --git a/test/index.html b/test/index.html deleted file mode 100644 index 44965ab..0000000 --- a/test/index.html +++ /dev/null @@ -1,10 +0,0 @@ - - - - -blah - - -

I'm the content

- -