Skip to content

Commit 6cfb4f6

Browse files
committed
Update docs.
1 parent 8a1471d commit 6cfb4f6

File tree

6 files changed

+20
-145
lines changed

6 files changed

+20
-145
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/autosummary_widths.py

Lines changed: 0 additions & 136 deletions
This file was deleted.

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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ seed-intersphinx-mapping>=0.3.1
99
sphinx>=3.0.3
1010
sphinx-copybutton>=0.2.12
1111
sphinx-debuginfo>=0.1.0
12+
sphinx-favicon>=0.2
1213
sphinx-licenseinfo>=0.1.1
1314
sphinx-notfound-page>=0.7.1
1415
sphinx-prompt>=1.1.0
1516
sphinx-pyproject>=0.1.0
1617
sphinx-tabs>=1.1.13
17-
sphinx-toolbox>=2.13.0
18+
sphinx-toolbox>=3.0.0a4
1819
sphinxcontrib-httpdomain>=1.7.0
1920
sphinxemoji>=0.1.6
2021
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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ short_desc: "A flake8 plugin which checks for use of platform specific strftime
1515
use_whey: true
1616
min_coverage: 100
1717
sphinx_html_theme: furo
18-
preserve_custom_theme: true
1918
docs_fail_on_warning: true
2019

2120
conda_channels:
@@ -42,16 +41,17 @@ classifiers:
4241
extra_sphinx_extensions:
4342
- sphinx_toolbox.pre_commit
4443
- sphinx_toolbox.flake8
45-
- sphinx_toolbox_experimental.autosummary_widths
46-
- sphinx_toolbox_experimental.needspace
44+
- sphinx_toolbox.more_autosummary.column_widths
45+
- sphinx-favicon
4746

4847
entry_points:
4948
flake8.extension:
5049
- STRFTIME=flake8_strftime:Plugin
5150

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

5656
tox_unmanaged:
5757
- testenv:lint

0 commit comments

Comments
 (0)