Skip to content

Commit 7e749d6

Browse files
committed
Update docs.
1 parent ce1ea39 commit 7e749d6

File tree

6 files changed

+21
-11
lines changed

6 files changed

+21
-11
lines changed

doc-source/_static/style.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ div.versionchanged ul, div.versionremoved ul {
1313
margin-left: 20px;
1414
margin-top: 0;
1515
}
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-formate.github.io/assets/formate.ico sizes="48x48" type="image/vnd.microsoft.icon">
65
{% endblock %}

doc-source/conf.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,10 @@ def setup(app):
7878

7979

8080
nitpicky = True
81-
autosummary_widths_builders = ["latex"]
81+
needspace_amount = r"5\baselineskip"
82+
favicons = [{
83+
"rel": "icon",
84+
"href": "https://python-formate.github.io/assets/formate.ico",
85+
"sizes": "48x48",
86+
"type": "image/vnd.microsoft.icon"
87+
}]

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
21
default-values>=0.5.0
32
extras-require>=0.2.0
43
furo>=2020.11.19b18
@@ -9,12 +8,13 @@ seed-intersphinx-mapping>=0.3.1
98
sphinx>=3.0.3
109
sphinx-copybutton>=0.2.12
1110
sphinx-debuginfo>=0.1.0
11+
sphinx-favicon>=0.2
1212
sphinx-licenseinfo>=0.1.1
1313
sphinx-notfound-page>=0.7.1
1414
sphinx-prompt>=1.1.0
1515
sphinx-pyproject>=0.1.0
1616
sphinx-tabs>=1.1.13
17-
sphinx-toolbox>=2.13.0
17+
sphinx-toolbox>=3.0.0a4
1818
sphinxcontrib-httpdomain>=1.7.0
1919
sphinxemoji>=0.1.6
2020
tabulate>=0.8.7

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ extensions = [
5555
"sphinx_toolbox.more_autosummary",
5656
"sphinx_toolbox.documentation_summary",
5757
"sphinx_toolbox.tweaks.param_dash",
58+
"sphinxcontrib.toctree_plus",
5859
"sphinx_toolbox.tweaks.latex_layout",
5960
"sphinx_toolbox.tweaks.latex_toc",
6061
"sphinx.ext.intersphinx",
@@ -65,15 +66,14 @@ extensions = [
6566
"notfound.extension",
6667
"sphinx_copybutton",
6768
"sphinxcontrib.default_values",
68-
"sphinxcontrib.toctree_plus",
6969
"sphinx_debuginfo",
7070
"sphinx_licenseinfo",
7171
"seed_intersphinx_mapping",
7272
"html_section",
7373
"sphinx_toolbox.pre_commit",
7474
"sphinx_toolbox.flake8",
75-
"sphinx_toolbox_experimental.autosummary_widths",
76-
"sphinx_toolbox_experimental.needspace",
75+
"sphinx_toolbox.more_autosummary.column_widths",
76+
"sphinx-favicon",
7777
]
7878
sphinxemoji_style = "twemoji"
7979
gitstamp_fmt = "%d %b %Y"

repo_helper.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ use_whey: true
1717
min_coverage: 100
1818
sphinx_html_theme: furo
1919
docs_fail_on_warning: true
20-
preserve_custom_theme: true
2120

2221
conda_channels:
2322
- conda-forge
@@ -43,16 +42,18 @@ classifiers:
4342
extra_sphinx_extensions:
4443
- sphinx_toolbox.pre_commit
4544
- sphinx_toolbox.flake8
46-
- sphinx_toolbox_experimental.autosummary_widths
47-
- sphinx_toolbox_experimental.needspace
45+
- sphinx_toolbox.more_autosummary.column_widths
46+
- sphinx-favicon
4847

4948
entry_points:
5049
flake8.extension:
5150
- SXL=flake8_sphinx_links:Plugin
5251

5352
sphinx_conf_epilogue:
5453
- nitpicky = True
55-
- autosummary_widths_builders = ["latex"]
54+
- needspace_amount = r"5\baselineskip"
55+
- 'favicons = [{"rel": "icon", "href": "https://python-formate.github.io/assets/formate.ico", "sizes": "48x48", "type": "image/vnd.microsoft.icon"}]'
56+
5657

5758
tox_unmanaged:
5859
- testenv:lint

0 commit comments

Comments
 (0)