Skip to content

Commit ddcd909

Browse files
docs: styling
1 parent 807491a commit ddcd909

5 files changed

Lines changed: 47 additions & 4 deletions

File tree

brave.png

157 KB
Loading

docs/source/conf.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
"sphinx_copybutton",
2525
"sphinx.ext.coverage",
2626
"sphinx_mdinclude",
27+
"sphinxext.opengraph",
28+
"sphinx_inline_tabs",
2729
]
2830

2931
templates_path = ["_templates"]
@@ -35,3 +37,14 @@
3537

3638
html_theme = "furo"
3739
html_static_path = ["_static"]
40+
html_logo = "../../brave.png"
41+
html_theme_options = {
42+
"announcement": (
43+
"Get Starbridge on "
44+
'<a target="_blank" href="https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client">GitHub</a> - '
45+
'<a target="_blank" href="https://pypi.org/project/brave-search-python-client/">PyPI</a> - '
46+
'<a target="_blank" href="https://hub.docker.com/r/helmuthva/brave-search-python-client/tags">Docker</a> - '
47+
'<a target="_blank" href="https://sonarcloud.io/summary/new_code?id=helmut-hoffer-von-ankershoffen_brave-search-python-client">SonarQube</a> - '
48+
'<a target="_blank" href="https://app.codecov.io/gh/helmut-hoffer-von-ankershoffen/brave-search-python-client">Codecov</a>'
49+
)
50+
}

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Welcome to brave-search-python-client's documentation!
1212

1313
readme
1414
contributing
15-
changelog
1615
reference_index
16+
changelog
1717

1818

1919
Indices and tables

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ dev = [
100100
"sphinx-autobuild>=2024.10.3",
101101
"sphinx-mdinclude>=0.6.2",
102102
"furo>=2024.8.6",
103+
"sphinx-inline-tabs>=2023.4.21",
104+
"sphinxext-opengraph>=0.9.1",
103105
]
104106

105107
[tool.ruff]

uv.lock

Lines changed: 31 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)