XeLabs/go-profiler-notes
2
0
Fork 0
mirror of https://github.com/DataDog/go-profiler-notes.git synced 2026-06-22 09:26:53 +08:00
Code Issues Projects Releases Wiki Activity

toc rework

Browse source
This commit is contained in:
Felix Geisendörfer 2022-12-27 20:18:00 +01:00
parent f176e96a47
commit e27d754ed0
16 changed files with 49 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/conf.py
View file

@ -8,7 +8,7 @@
import sphinx_rtd_theme import sphinx_rtd_theme
project = 'Datadog\'s Go Observability Guide' project = 'go-profiler-notes'
copyright = '2022, Datadog' copyright = '2022, Datadog'
author = 'Felix Geisendörfer, Nick Ripley' author = 'Felix Geisendörfer, Nick Ripley'
@ -36,6 +36,8 @@ html_theme = 'sphinx_rtd_theme'
html_theme_options = { html_theme_options = {
'style_nav_header_background': '#5C2EA0', 'style_nav_header_background': '#5C2EA0',
'collapse_navigation': False, 'collapse_navigation': False,
'navigation_depth': 5,
'includehidden': False,
} }
html_static_path = ['_static'] html_static_path = ['_static']
html_css_files = ['css/custom.css'] html_css_files = ['css/custom.css']

27
docs/index.rst
View file

@ -1,4 +1,4 @@
Go Profiler Notes go-profiler-notes
================= =================
Formerly known as "go-profiler-notes", this guide contains in-depth information 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. be covered as well.
.. toctree:: .. toctree::
:maxdepth: 3 :hidden:
:caption: Contents:
about
profiling/index 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

2
docs/mental-model-for-go/garbage-collector.rst Normal file
View file

@ -0,0 +1,2 @@
Garbage Collector
=================

2
docs/mental-model-for-go/goroutine-scheduler.rst Normal file
View file

@ -0,0 +1,2 @@
Goroutine Scheduler
===================

9
docs/mental-model-for-go/index.rst Normal file
View file

@ -0,0 +1,9 @@
Mental Model for Go
===================
.. toctree::
:maxdepth: 2
:caption: Contents:
goroutine-scheduler
garbage-collector

2
docs/misc/pprof.rst Normal file
View file

@ -0,0 +1,2 @@
pprof Tool and Format
=====================

4
docs/misc/stack-traces.rst Normal file
View file

@ -0,0 +1,4 @@
Stack Traces
============

9
docs/profiling/builtin-profilers/index.rst
View file

@ -1,9 +0,0 @@
Builtin Profilers
=================
.. toctree::
:maxdepth: 2
:caption: Contents:
cpu-profiler
memory-profiler

0
docs/profiling/builtin-profilers/cpu-profiler-net-http-pprof.go → docs/profiling/cpu-profiler-net-http-pprof.go
View file

0
docs/profiling/builtin-profilers/cpu-profiler-start-stop.go → docs/profiling/cpu-profiler-start-stop.go
View file

0
docs/profiling/builtin-profilers/cpu-profiler-trace.go → docs/profiling/cpu-profiler-trace.go
View file

0
docs/profiling/builtin-profilers/cpu-profiler.rst → docs/profiling/cpu-profiler.rst
View file

8
docs/profiling/index.rst
View file

@ -1,8 +1,8 @@
Profiling Profilers
========= =========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Contents:
builtin-profilers/index cpu-profiler
memory-profiler

0
docs/profiling/builtin-profilers/memory-profiler-gc.go → docs/profiling/memory-profiler-gc.go
View file

0
docs/profiling/builtin-profilers/memory-profiler.rst → docs/profiling/memory-profiler.rst
View file

10
test/index.html
View file

@ -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>