Improve docs layout

Author: domdfcoding

.bumpversion.cfg

@@ -18,3 +18,7 @@ search = version = "{current_version}"
 replace = version = "{new_version}"
 
 [bumpversion:file:.github/workflows/conda_ci.yml]
+
+[bumpversion:file:flake8_sphinx_links/__init__.py]
+search = : str = "{current_version}"
+replace = : str = "{new_version}"

doc-source/_static/style.css

@@ -8,3 +8,8 @@ div.highlight {
 .field-list dt, dl.simple dt {
 	margin-top: 0.5rem;
 }
+
+div.versionchanged ul, div.versionremoved ul {
+	margin-left: 20px;
+	margin-top: 0;
+}

doc-source/api.rst

@@ -2,5 +2,18 @@
 API Reference
 ================
 
+In addition to the Flake8 plugin, the following public API is available
+to allow other plugins to build on top of ``flake8-strftime``.
+
+.. autosummary-widths:: 25/100
+
 .. automodule:: flake8_strftime
-	:undoc-members:
+	:no-docstring:
+	:no-members:
+	:autosummary-members:
+
+.. autoclass:: flake8_strftime.Plugin
+	:no-members:
+
+.. autoclass:: flake8_strftime.Visitor
+	:no-members:

doc-source/conf.py

@@ -75,3 +75,7 @@ def setup(app):
 	from sphinx_toolbox.latex import better_header_layout
 
 	app.connect("config-inited", lambda app, config: better_header_layout(config))
+
+
+nitpicky = True
+autosummary_widths_builders = ["latex"]

doc-source/index.rst

@@ -136,11 +136,13 @@ Installation
 
 .. end installation
 
+
 Contents
 ---------
 
 .. html-section::
 
+
 .. toctree::
 	:hidden:
 
@@ -152,6 +154,7 @@ Contents
 	usage
 	api
 	Source
+	license
 
 .. sidebar-links::
 	:caption: Links

doc-source/requirements.txt

@@ -1,4 +1,4 @@
-git+https://github.com/sphinx-toolbox/html-section
+git+https://github.com/sphinx-toolbox/sphinx-toolbox-experimental
 default-values>=0.5.0
 extras-require>=0.2.0
 furo>=2020.11.19b18

flake8_strftime/__init__.py

@@ -58,9 +58,6 @@
 class Visitor(flake8_helper.Visitor):
 	"""
 	AST node visitor for identifying platform specific strftime codes.
-
-	.. autoclasssumm::
-		:autosummary-sections: ;;
 	"""  # noqa: RST303
 
 	def __init__(self) -> None:

pyproject.toml

@@ -71,8 +71,9 @@ extensions = [
     "seed_intersphinx_mapping",
     "sphinx_toolbox.pre_commit",
     "sphinx_toolbox.flake8",
-    "html_section",
-    "autosummary_widths",
+    "sphinx_toolbox_experimental.html_section",
+    "sphinx_toolbox_experimental.autosummary_widths",
+    "sphinx_toolbox_experimental.needspace",
 ]
 sphinxemoji_style = "twemoji"
 gitstamp_fmt = "%d %b %Y"

repo_helper.yml

@@ -15,7 +15,6 @@ short_desc: "A flake8 plugin which checks for use of platform specific strftime
 use_whey: true
 min_coverage: 100
 sphinx_html_theme: furo
-standalone_contrib_guide: true
 preserve_custom_theme: true
 
 conda_channels:
@@ -40,13 +39,18 @@ classifiers:
 extra_sphinx_extensions:
  - sphinx_toolbox.pre_commit
  - sphinx_toolbox.flake8
- - html_section
- - autosummary_widths
+ - sphinx_toolbox_experimental.html_section
+ - sphinx_toolbox_experimental.autosummary_widths
+ - sphinx_toolbox_experimental.needspace
 
 entry_points:
   flake8.extension:
    - STRFTIME=flake8_strftime:Plugin
 
+sphinx_conf_epilogue:
+ - nitpicky = True
+ - autosummary_widths_builders = ["latex"]
+
 tox_unmanaged:
  - testenv:lint