Skip to content

Commit 0a6fac5

Browse files
authored
docs: furo theme (#340)
2 parents 4b18b47 + bc8aff4 commit 0a6fac5

File tree

4 files changed

+75
-46
lines changed

4 files changed

+75
-46
lines changed

docs/_static/img/vcspull-dark.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/conf.py

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
import os
22

3-
import alagitpull
4-
53
# Get the project root dir, which is the parent dir of this
64
cwd = os.getcwd()
75
project_root = os.path.dirname(cwd)
@@ -18,7 +16,6 @@
1816
"sphinx.ext.todo",
1917
"sphinx.ext.napoleon",
2018
"sphinx.ext.linkcode",
21-
"alagitpull",
2219
"sphinx_issues",
2320
"sphinx_click.ext", # sphinx-click
2421
"myst_parser",
@@ -33,7 +30,6 @@ def setup(app):
3330

3431

3532
issues_github_path = about["__github__"].replace("https://github.com/", "")
36-
3733
templates_path = ["_templates"]
3834

3935
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
@@ -49,41 +45,40 @@ def setup(app):
4945
exclude_patterns = ["_build"]
5046

5147
pygments_style = "sphinx"
48+
pygments_dark_style = "monokai"
5249

53-
html_theme_path = [alagitpull.get_path()]
54-
html_theme = "alagitpull"
50+
html_favicon = "_static/favicon.ico"
51+
html_theme_path = []
52+
html_theme = "furo"
5553
html_theme_options = {
56-
"logo": "img/vcspull.svg",
57-
"github_user": "vcs-python",
58-
"github_repo": "vcspull",
59-
"github_type": "star",
60-
"github_banner": True,
61-
"projects": alagitpull.projects,
62-
"project_name": about["__title__"],
63-
"project_title": about["__title__"],
64-
"project_description": about["__description__"],
65-
"project_url": about["__docs__"],
66-
"show_meta_manifest_tag": True,
67-
"show_meta_og_tags": True,
68-
"show_meta_app_icon_tags": True,
54+
"light_logo": "img/vcspull.svg",
55+
"dark_logo": "img/vcspull-dark.svg",
56+
"footer_icons": [
57+
{
58+
"name": "GitHub",
59+
"url": "https://github.com/vcs-python/vcspull",
60+
"html": """
61+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
62+
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
63+
</svg>
64+
""",
65+
"class": "",
66+
},
67+
],
6968
}
7069
html_sidebars = {
7170
"**": [
72-
"about.html",
73-
"navigation.html",
74-
"relations.html",
75-
"more.html",
76-
"searchbox.html",
71+
"sidebar/scroll-start.html",
72+
"sidebar/brand.html",
73+
"sidebar/search.html",
74+
"sidebar/navigation.html",
75+
"sidebar/scroll-end.html",
7776
]
7877
}
7978

8079
html_static_path = ["_static"]
8180
html_extra_path = ["manifest.json"]
8281

83-
alagitpull_internal_hosts = ["vcspull.git-pull.com", "0.0.0.0"]
84-
alagitpull_external_hosts_new_window = True
85-
86-
8782
htmlhelp_basename = "%sdoc" % about["__title__"]
8883

8984
latex_documents = [

poetry.lock

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

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ colorama = ">=0.3.9"
5050
[tool.poetry.dev-dependencies]
5151
### Docs ###
5252
sphinx = "*"
53-
alagitpull = "^0.1.0"
53+
furo = "^2022.2.23"
5454
sphinx-issues = "^3.0.0"
5555
sphinx-click = "*"
5656
sphinx-autodoc-typehints = "~1.17.0"
@@ -74,7 +74,7 @@ isort = "*"
7474
flake8 = "*"
7575

7676
[tool.poetry.extras]
77-
docs = ["sphinx", "sphinx-issues", "sphinx-click", "sphinx-autodoc-typehints", "myst_parser", "sphinx-autobuild", "alagitpull"]
77+
docs = ["sphinx", "sphinx-issues", "sphinx-click", "sphinx-autodoc-typehints", "myst_parser", "sphinx-autobuild", "alagitpull", "furo"]
7878
test = ["pytest", "pytest-rerunfailures"]
7979
coverage = ["codecov", "coverage", "pytest-cov"]
8080
format = ["black", "isort"]

0 commit comments

Comments
 (0)