Skip to content

Commit 191f6b3

Browse files
committed
Update docs.
1 parent b7f21a4 commit 191f6b3

File tree

10 files changed

+29
-11
lines changed

10 files changed

+29
-11
lines changed

coverage_pyver_pragma/grammar.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,8 @@ class PlatformTag(str):
249249
Darwin # macOS
250250
Java
251251
252+
.. latex:clearpage::
253+
252254
If the current platform cannot be determined all strings are treated as :py:obj:`True`.
253255
254256
:param tokens:

doc-source/_static/style.css

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,12 @@ div.highlight {
88
.field-list dt, dl.simple dt {
99
margin-top: 0.5rem;
1010
}
11+
12+
div.versionchanged ul, div.versionremoved ul {
13+
margin-left: 20px;
14+
margin-top: 0;
15+
}
16+
17+
.longtable.autosummary {
18+
width: 100%;
19+
}

doc-source/_templates/base.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@
22
{% extends "!base.html" %}
33
{% block extrahead %}
44
<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
5-
<link rel=icon href=https://python-coincidence.github.io/assets/coincidence.ico sizes="48x48" type="image/vnd.microsoft.icon">
65
{% endblock %}

doc-source/api.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,5 @@ Public API
33
=============
44

55
.. autosummary-widths:: 6/16
6-
:html: 35/100
76

87
.. automodule:: coverage_pyver_pragma

doc-source/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,10 @@ def setup(app):
7979

8080

8181
toctree_plus_types.add("envvar")
82+
needspace_amount = r"5\baselineskip"
83+
favicons = [{
84+
"rel": "icon",
85+
"href": "https://python-coincidence.github.io/assets/coincidence.ico",
86+
"sizes": "48x48",
87+
"type": "image/vnd.microsoft.icon"
88+
}]

doc-source/configuration.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ For instance, you are generating a report from a ``.coverage`` file produced on
4949

5050
COV_PYTHON_IMPLEMENTATION=PyPy coverage report
5151

52+
.. latex:clearpage::
53+
5254
If you generate your coverage reports through `tox <https://tox.readthedocs.io/en/latest/>`_
5355
you should configure `passenv <https://tox.readthedocs.io/en/latest/config.html?highlight=setenv#conf-passenv>`_
5456
to ensure the environment variables are passed through:

doc-source/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
git+https://github.com/sphinx-toolbox/sphinx-toolbox-experimental.git
21
default-values>=0.5.0
32
extras-require>=0.2.0
43
furo>=2020.11.19b18
@@ -7,12 +6,13 @@ seed-intersphinx-mapping>=0.3.1
76
sphinx>=3.0.3
87
sphinx-copybutton>=0.2.12
98
sphinx-debuginfo>=0.1.0
9+
sphinx-favicon>=0.2
1010
sphinx-licenseinfo>=0.1.1
1111
sphinx-notfound-page>=0.7.1
1212
sphinx-prompt>=1.1.0
1313
sphinx-pyproject>=0.1.0
1414
sphinx-tabs>=1.1.13
15-
sphinx-toolbox>=2.13.0
15+
sphinx-toolbox>=3.0.0a4
1616
sphinxcontrib-httpdomain>=1.7.0
1717
sphinxemoji>=0.1.6
1818
toctree-plus>=0.5.0

doc-source/syntax.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ Syntax
33
=========
44

55
.. autosummary-widths:: 6/16
6-
:html: 3/10
76

87
.. automodule:: coverage_pyver_pragma.grammar
98
:no-autosummary:

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ extensions = [
5454
"sphinx_toolbox.more_autosummary",
5555
"sphinx_toolbox.documentation_summary",
5656
"sphinx_toolbox.tweaks.param_dash",
57+
"sphinxcontrib.toctree_plus",
5758
"sphinx_toolbox.tweaks.latex_layout",
5859
"sphinx_toolbox.tweaks.latex_toc",
5960
"sphinx.ext.intersphinx",
@@ -64,13 +65,12 @@ extensions = [
6465
"notfound.extension",
6566
"sphinx_copybutton",
6667
"sphinxcontrib.default_values",
67-
"sphinxcontrib.toctree_plus",
6868
"sphinx_debuginfo",
6969
"sphinx_licenseinfo",
7070
"seed_intersphinx_mapping",
7171
"html_section",
72-
"sphinx_toolbox_experimental.autosummary_widths",
73-
"sphinx_toolbox_experimental.needspace",
72+
"sphinx_toolbox.more_autosummary.column_widths",
73+
"sphinx-favicon",
7474
]
7575
sphinxemoji_style = "twemoji"
7676
gitstamp_fmt = "%d %b %Y"

repo_helper.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ use_whey: True
1414
min_coverage: 95
1515
sphinx_html_theme: furo
1616
python_deploy_version: 3.6
17-
preserve_custom_theme: true
1817
docs_fail_on_warning: true
1918

2019
conda_channels:
@@ -48,11 +47,13 @@ keywords:
4847
- coverage
4948

5049
extra_sphinx_extensions:
51-
- sphinx_toolbox_experimental.autosummary_widths
52-
- sphinx_toolbox_experimental.needspace
50+
- sphinx_toolbox.more_autosummary.column_widths
51+
- sphinx-favicon
5352

5453
exclude_files:
5554
- contributing
5655

5756
sphinx_conf_epilogue:
5857
- toctree_plus_types.add("envvar")
58+
- needspace_amount = r"5\baselineskip"
59+
- 'favicons = [{"rel": "icon", "href": "https://python-coincidence.github.io/assets/coincidence.ico", "sizes": "48x48", "type": "image/vnd.microsoft.icon"}]'

0 commit comments

Comments
 (0)