Skip to content

Commit 7c78ac4

Browse files
committed
Update docs.
1 parent d48c241 commit 7c78ac4

File tree

11 files changed

+27
-5
lines changed

11 files changed

+27
-5
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/api/config.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
:mod:`snippet_fmt.config`
33
===========================
44

5+
.. autosummary-widths:: 3/10
56
.. automodule:: snippet_fmt.config

doc-source/api/formatters.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
:mod:`snippet_fmt.formatters`
33
===============================
44

5+
.. autosummary-widths:: 4/10
56
.. automodule:: snippet_fmt.formatters

doc-source/api/snippet-fmt.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
:mod:`snippet_fmt`
33
========================
44

5+
.. autosummary-widths:: 45/100
56
.. automodule:: snippet_fmt

doc-source/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,10 @@ def setup(app):
8080
nitpicky = True
8181
toctree_plus_types.add("tconf")
8282
toml_spec_version = "0.5.0"
83+
needspace_amount = r"5\baselineskip"
84+
favicons = [{
85+
"rel": "icon",
86+
"href": "https://python-formate.github.io/assets/formate.ico",
87+
"sizes": "48x48",
88+
"type": "image/vnd.microsoft.icon"
89+
}]

doc-source/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ seed-intersphinx-mapping>=0.3.1
88
sphinx>=3.0.3
99
sphinx-copybutton>=0.2.12
1010
sphinx-debuginfo>=0.1.0
11+
sphinx-favicon>=0.2
1112
sphinx-licenseinfo>=0.1.1
1213
sphinx-notfound-page>=0.7.1
1314
sphinx-packaging>=0.1.0

pyproject.toml

Lines changed: 3 additions & 2 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,15 +65,15 @@ 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",
7272
"attr_utils.autoattrs",
7373
"sphinx_click",
7474
"sphinx_toolbox.pre_commit",
75-
"sphinx_toolbox_experimental.autosummary_widths",
75+
"sphinx_toolbox.more_autosummary.column_widths",
76+
"sphinx-favicon",
7677
"sphinx_toolbox_experimental.missing_xref",
7778
"sphinx_packaging",
7879
]

repo_helper.yml

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

2019
python_versions:
@@ -42,7 +41,8 @@ extra_sphinx_extensions:
4241
- attr_utils.autoattrs
4342
- sphinx_click
4443
- sphinx_toolbox.pre_commit
45-
- sphinx_toolbox_experimental.autosummary_widths
44+
- sphinx_toolbox.more_autosummary.column_widths
45+
- sphinx-favicon
4646
# - sphinx_toolbox_experimental.changelog
4747
- sphinx_toolbox_experimental.missing_xref
4848
- sphinx_packaging
@@ -53,6 +53,8 @@ sphinx_conf_epilogue:
5353
- nitpicky = True
5454
- toctree_plus_types.add("tconf")
5555
- toml_spec_version = "0.5.0"
56+
- needspace_amount = r"5\baselineskip"
57+
- 'favicons = [{"rel": "icon", "href": "https://python-formate.github.io/assets/formate.ico", "sizes": "48x48", "type": "image/vnd.microsoft.icon"}]'
5658

5759
exclude_files:
5860
- contributing

snippet_fmt/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ class RSTReformatter:
7979
8080
:param filename: The filename to reformat.
8181
:param config: The ``snippet_fmt`` configuration, parsed from a TOML file (or similar).
82+
83+
.. autosummary-widths:: 35/100
84+
.. latex:clearpage::
8285
"""
8386

8487
#: The filename being reformatted.

0 commit comments

Comments
 (0)