Merge branch 'main' into ZipkinEndpointConfig

api/docs/conf.py

@@ -76,7 +76,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/public/_templates/sidebar/brand.html

@@ -0,0 +1,8 @@
+<a class="sidebar-brand{% if logo %} centered{% endif %}" href="{{ pathto(master_doc) }}">
+  {% block brand_content %}
+  {% if not theme_sidebar_hide_name %}
+  <img class="sidebar-logo" style="width: 40%;" src="{{ pathto('_static/opentelemetry_logo.png', 1) }}" alt="Logo"/>
+  <span class="sidebar-brand-text" style="font-size: 100%; font-weight: bold; color: grey;">OpenTelemetry C++ {{ release }}</span>
+  {%- endif %}
+  {% endblock brand_content %}
+</a>`

docs/public/conf.py

@@ -34,9 +34,24 @@
 apidir = os.path.join('..', '..', 'api', 'docs')
 subprocess.call(['make', 'html'], cwd=apidir)
 targetdir = os.path.join(os.getcwd(), 'otel_api')
+sourcedir = os.path.join(apidir, 'otel_api')
 if os.path.exists(targetdir):
-    shutil.rmtree(targetdir)
-shutil.copytree(os.path.join(apidir, 'otel_api'), targetdir)
+  shutil.rmtree(targetdir)
+os.makedirs(targetdir)
+
+# Now copying the previously created APi documentation. Table of contents
+# are filtered out, because those don't go well together with the furo theme.
+for fname in os.listdir(sourcedir):
+  with open(os.path.join(sourcedir, fname), 'r') as fin:
+    with open(os.path.join(targetdir, fname), 'w') as fout:
+      skip = False
+      for line in fin:
+        if line.startswith('.. contents'):
+          skip = True
+        elif not line.startswith(' '):
+          skip = False
+        if not skip:
+          fout.write(line)
 
 # -- General configuration ---------------------------------------------------
 
@@ -72,7 +87,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/public/requirements.txt

@@ -1,2 +1,3 @@
 breathe
 exhale
+furo

tools/format.sh

@@ -6,7 +6,7 @@ fi
 
 set -e
 
-FIND="find . -name third_party -prune -o -name tools -prune -o -name .git -prune -o -name _deps -prune -o -name .build -prune -o -name out -prune -o -name .vs -prune -o -name opentelemetry_logo.jpg -prune -o"
+FIND="find . -name third_party -prune -o -name tools -prune -o -name .git -prune -o -name _deps -prune -o -name .build -prune -o -name out -prune -o -name .vs -prune -o -name opentelemetry_logo.png -prune -o"
 
 # GNU syntax.
 SED=(sed -i)