Skip to content

Commit 0472165

Browse files
committed
Switch documentation theme to Furo and Whey as the build backend.
1 parent b13a17d commit 0472165

File tree

6 files changed

+51
-14
lines changed

6 files changed

+51
-14
lines changed

doc-source/_static/style.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/* This file is managed by 'repo_helper'. Don't edit it directly. */
2+
3+
div.highlight {
4+
-moz-tab-size: 4; /* Firefox */
5+
tab-size: 4;
6+
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--- This file is managed by 'repo_helper'. Don't edit it directly. --->
2-
{% extends "!layout.html" %}
2+
{% extends "!base.html" %}
33
{% block extrahead %}
44
<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
55
{% endblock %}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!---This file is managed by 'repo_helper'. Don't edit it directly.--->
2+
<div class="sidebar-tree">
3+
{{ furo_navigation_tree }}
4+
</div>
5+
6+
<div class="sidebar-tree">
7+
<p class="caption"><span class="caption-text">Links</span></p>
8+
<ul>
9+
<li class="toctree-l1"><a class="reference external" href="https://github.com/domdfcoding/coverage_pyver_pragma">GitHub</a></li>
10+
<li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/coverage_pyver_pragma">PyPI</a></li>
11+
</ul>
12+
</div>

doc-source/conf.py

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,18 +65,23 @@
6565
"pyparsing": ("https://pyparsing-docs.readthedocs.io/en/latest", None),
6666
}
6767

68-
html_theme = "domdf_sphinx_theme"
69-
html_theme_options = {"logo_only": False}
68+
html_theme = "furo"
69+
html_theme_options = {
70+
"light_css_variables": {
71+
"toc-title-font-size": "12pt",
72+
"toc-font-size": "12pt",
73+
"admonition-font-size": "12pt",
74+
},
75+
"dark_css_variables": {
76+
"toc-title-font-size": "12pt",
77+
"toc-font-size": "12pt",
78+
"admonition-font-size": "12pt",
79+
},
80+
}
7081
html_theme_path = ["../.."]
7182
html_show_sourcelink = True # True will show link to source
7283

73-
html_context = {
74-
"display_github": True,
75-
"github_user": "domdfcoding",
76-
"github_repo": "coverage_pyver_pragma",
77-
"github_version": "master",
78-
"conf_py_path": "/doc-source/",
79-
}
84+
html_context = {}
8085
htmlhelp_basename = slug
8186

8287
latex_documents = [("index", f'{slug}.tex', project, author, "manual")]

pyproject.toml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[build-system]
2-
requires = [ "setuptools>=40.6.0", "wheel>=0.34.2",]
3-
build-backend = "setuptools.build_meta"
2+
requires = [ "whey",]
3+
build-backend = "whey"
44

55
[project]
66
name = "coverage_pyver_pragma"
@@ -21,3 +21,15 @@ Homepage = "https://github.com/domdfcoding/coverage_pyver_pragma"
2121
"Issue Tracker" = "https://github.com/domdfcoding/coverage_pyver_pragma/issues"
2222
"Source Code" = "https://github.com/domdfcoding/coverage_pyver_pragma"
2323
Documentation = "https://coverage_pyver_pragma.readthedocs.io/en/latest"
24+
25+
[tool.whey]
26+
base-classifiers = [
27+
"Development Status :: 4 - Beta",
28+
"Intended Audience :: Developers",
29+
"Topic :: Utilities",
30+
"Typing :: Typed",
31+
]
32+
python-versions = [ "3.6", "3.7", "3.8", "3.9",]
33+
python-implementations = [ "CPython", "PyPy",]
34+
platforms = [ "Windows", "macOS", "Linux",]
35+
license-key = "MIT"

repo_helper.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ username: "domdfcoding"
88
license: 'MIT'
99
short_desc: "Plugin for Coverage.py to selectively ignore branches depending on the Python version."
1010

11+
use_whey: True
12+
min_coverage: 95
13+
sphinx_html_theme: furo
14+
1115
conda_channels:
1216
- conda-forge
1317

@@ -28,8 +32,6 @@ classifiers:
2832
- 'Intended Audience :: Developers'
2933
- "Topic :: Utilities"
3034

31-
sphinx_html_theme: domdf_sphinx_theme
32-
3335
tox_unmanaged:
3436
- coverage:run
3537
- testenv:coverage

0 commit comments

Comments
 (0)