docs: styling

helmut-hoffer-von-ankershoffen · Jan 2, 2025 · ddcd909 · ddcd909
1 parent 807491a
commit ddcd909
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 4 deletions.
diff --git a/brave.png b/brave.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,6 +24,8 @@
     "sphinx_copybutton",
     "sphinx.ext.coverage",
     "sphinx_mdinclude",
+    "sphinxext.opengraph",
+    "sphinx_inline_tabs",
 ]
 
 templates_path = ["_templates"]
@@ -35,3 +37,14 @@
 
 html_theme = "furo"
 html_static_path = ["_static"]
+html_logo = "../../brave.png"
+html_theme_options = {
+    "announcement": (
+        "Get Starbridge on "
+        '<a target="_blank" href="https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client">GitHub</a> - '
+        '<a target="_blank" href="https://pypi.org/project/brave-search-python-client/">PyPI</a> - '
+        '<a target="_blank" href="https://hub.docker.com/r/helmuthva/brave-search-python-client/tags">Docker</a> - '
+        '<a target="_blank" href="https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client">SonarQube</a> - '
+        '<a target="_blank" href="https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/brave-search-python-client">Codecov</a>'
+    )
+}
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,8 +12,8 @@ Welcome to brave-search-python-client's documentation!
 
    readme
    contributing
-   changelog
    reference_index
+   changelog
 
 
 Indices and tables

diff --git a/pyproject.toml b/pyproject.toml
@@ -100,6 +100,8 @@ dev = [
     "sphinx-autobuild>=2024.10.3",
     "sphinx-mdinclude>=0.6.2",
     "furo>=2024.8.6",
+    "sphinx-inline-tabs>=2023.4.21",
+    "sphinxext-opengraph>=0.9.1",
 ]
 
 [tool.ruff]

diff --git a/uv.lock b/uv.lock