Update docs.

Author: domdfcoding

doc-source/_static/style.css

@@ -13,3 +13,7 @@ div.versionchanged ul, div.versionremoved ul {
 	margin-left: 20px;
 	margin-top: 0;
 }
+
+.longtable.autosummary {
+	width: 100%;
+}

doc-source/_templates/base.html

@@ -2,5 +2,4 @@
 {% extends "!base.html" %}
 {% block extrahead %}
 	<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
-	<link rel=icon href=https://python-formate.github.io/assets/formate.ico sizes="48x48" type="image/vnd.microsoft.icon">
 {% endblock %}

doc-source/api/config.rst

@@ -2,4 +2,5 @@
 :mod:`snippet_fmt.config`
 ===========================
 
+.. autosummary-widths:: 3/10
 .. automodule:: snippet_fmt.config

doc-source/api/formatters.rst

@@ -2,4 +2,5 @@
 :mod:`snippet_fmt.formatters`
 ===============================
 
+.. autosummary-widths:: 4/10
 .. automodule:: snippet_fmt.formatters

doc-source/api/snippet-fmt.rst

@@ -2,4 +2,5 @@
 :mod:`snippet_fmt`
 ========================
 
+.. autosummary-widths:: 45/100
 .. automodule:: snippet_fmt

doc-source/conf.py

@@ -80,3 +80,10 @@ def setup(app):
 nitpicky = True
 toctree_plus_types.add("tconf")
 toml_spec_version = "0.5.0"
+needspace_amount = r"5\baselineskip"
+favicons = [{
+		"rel": "icon",
+		"href": "https://python-formate.github.io/assets/formate.ico",
+		"sizes": "48x48",
+		"type": "image/vnd.microsoft.icon"
+		}]

doc-source/requirements.txt

@@ -8,6 +8,7 @@ seed-intersphinx-mapping>=0.3.1
 sphinx>=3.0.3
 sphinx-copybutton>=0.2.12
 sphinx-debuginfo>=0.1.0
+sphinx-favicon>=0.2
 sphinx-licenseinfo>=0.1.1
 sphinx-notfound-page>=0.7.1
 sphinx-packaging>=0.1.0

pyproject.toml

@@ -54,6 +54,7 @@ extensions = [
     "sphinx_toolbox.more_autosummary",
     "sphinx_toolbox.documentation_summary",
     "sphinx_toolbox.tweaks.param_dash",
+    "sphinxcontrib.toctree_plus",
     "sphinx_toolbox.tweaks.latex_layout",
     "sphinx_toolbox.tweaks.latex_toc",
     "sphinx.ext.intersphinx",
@@ -64,15 +65,15 @@ extensions = [
     "notfound.extension",
     "sphinx_copybutton",
     "sphinxcontrib.default_values",
-    "sphinxcontrib.toctree_plus",
     "sphinx_debuginfo",
     "sphinx_licenseinfo",
     "seed_intersphinx_mapping",
     "html_section",
     "attr_utils.autoattrs",
     "sphinx_click",
     "sphinx_toolbox.pre_commit",
-    "sphinx_toolbox_experimental.autosummary_widths",
+    "sphinx_toolbox.more_autosummary.column_widths",
+    "sphinx-favicon",
     "sphinx_toolbox_experimental.missing_xref",
     "sphinx_packaging",
 ]

repo_helper.yml

@@ -14,7 +14,6 @@ enable_conda: false
 use_whey: true
 min_coverage: 95
 sphinx_html_theme: furo
-preserve_custom_theme: true
 docs_fail_on_warning: true
 
 python_versions:
@@ -42,7 +41,8 @@ extra_sphinx_extensions:
  - attr_utils.autoattrs
  - sphinx_click
  - sphinx_toolbox.pre_commit
- - sphinx_toolbox_experimental.autosummary_widths
+ - sphinx_toolbox.more_autosummary.column_widths
+ - sphinx-favicon
 # - sphinx_toolbox_experimental.changelog
  - sphinx_toolbox_experimental.missing_xref
  - sphinx_packaging
@@ -53,6 +53,8 @@ sphinx_conf_epilogue:
  - nitpicky = True
  - toctree_plus_types.add("tconf")
  - toml_spec_version = "0.5.0"
+ - needspace_amount = r"5\baselineskip"
+ - 'favicons = [{"rel": "icon", "href": "https://python-formate.github.io/assets/formate.ico",  "sizes": "48x48", "type": "image/vnd.microsoft.icon"}]'
 
 exclude_files:
  - contributing

snippet_fmt/__init__.py

@@ -79,6 +79,9 @@ class RSTReformatter:
 
 	:param filename: The filename to reformat.
 	:param config: The ``snippet_fmt`` configuration, parsed from a TOML file (or similar).
+	
+	.. autosummary-widths:: 35/100
+	.. latex:clearpage::
 	"""
 
 	#: The filename being reformatted.