Skip to content

Commit d0bd878

Browse files
committed
Update docs config.
1 parent 4ce4b90 commit d0bd878

File tree

7 files changed

+35
-11
lines changed

7 files changed

+35
-11
lines changed

.github/workflows/docs_test_action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ jobs:
3333
with:
3434
pre-build-command: python -m pip install tox
3535
docs-folder: "doc-source/"
36-
build-command: "tox -e docs -- "
36+
build-command: "tox -e docs -- -W "

doc-source/_static/style.css

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/* This file is managed by 'repo_helper'. Don't edit it directly. */
2+
3+
div.highlight {
4+
-moz-tab-size: 4;
5+
tab-size: 4;
6+
}
7+
8+
.field-list dt, dl.simple dt {
9+
margin-top: 0.5rem;
10+
}
11+
12+
div.versionchanged ul, div.versionremoved ul {
13+
margin-left: 20px;
14+
margin-top: 0;
15+
}

doc-source/_templates/base.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!--- This file is managed by 'repo_helper'. Don't edit it directly. --->
2+
{% extends "!base.html" %}
3+
{% block extrahead %}
4+
<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
5+
{% endblock %}

doc-source/conf.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,6 @@ def setup(app):
7575
from sphinx_toolbox.latex import better_header_layout
7676

7777
app.connect("config-inited", lambda app, config: better_header_layout(config))
78+
79+
80+
nitpicky = True

doc-source/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,12 @@ Installation
156156
Contributing Guide<https://contributing-to-formate.readthedocs.io>
157157

158158

159+
.. sidebar-links::
160+
:caption: Links
161+
:github:
162+
:pypi: snippet-fmt
163+
164+
159165
.. start links
160166
161167
.. only:: html

repo_helper.yml

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,9 @@ enable_conda: false
1414
use_whey: true
1515
min_coverage: 95
1616
sphinx_html_theme: furo
17-
preserve_custom_theme: true
17+
#preserve_custom_theme: true
1818
mypy_version: "0.910"
19-
20-
conda_channels:
21-
- conda-forge
19+
docs_fail_on_warning: true
2220

2321
python_versions:
2422
- '3.6'
@@ -49,13 +47,10 @@ extra_sphinx_extensions:
4947
# - sphinx_toolbox_experimental.changelog
5048
- sphinx_toolbox_experimental.missing_xref
5149

52-
#sphinx_conf_epilogue:
50+
sphinx_conf_epilogue:
5351
# - "\tfrom sphinx_toolbox.latex import replace_unknown_unicode"
5452
# - "\tapp.connect('build-finished', replace_unknown_unicode)"
55-
# - nitpicky = True
56-
57-
#mypy_deps:
58-
# - types-attrs>=0.1.0
53+
- nitpicky = True
5954

6055
exclude_files:
6156
- contributing

snippet_fmt/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ def run(self) -> bool:
143143

144144
def process_match(self, match: Match[str]) -> str:
145145
"""
146-
Process a :class:`re.Match` for a single code block.
146+
Process a :meth:`re.Match <re.Match.expand>` for a single code block.
147147
148148
:param match:
149149
"""

0 commit comments

Comments
 (0)