Improve docs layout.

Author: domdfcoding

doc-source/index.rst

@@ -9,7 +9,9 @@ flake8-encodings
 
 .. end short_desc
 
-.. seealso:: :pep:`597` -- Add optional EncodingWarning
+.. only:: html
+
+	.. seealso:: :pep:`597` -- Add optional EncodingWarning
 
 .. start shields
 
@@ -180,6 +182,8 @@ which can be used in conjunction with this tool to identify issues at runtime.
 Contents
 -------------
 
+.. html-section::
+
 .. toctree::
 	:hidden:
 
@@ -213,6 +217,8 @@ Contents
 Footnotes
 -------------
 
+.. html-section::
+
 .. [1] "Packages can't be installed when encoding is not UTF-8"
        (https://github.com/methane/pep597-pypi-ascii)
 

doc-source/requirements.txt

@@ -1,3 +1,4 @@
+git+https://github.com/sphinx-toolbox/sphinx-toolbox-experimental
 autodocsumm>=0.2.0
 default-values>=0.4.2
 extras-require>=0.2.0

doc-source/usage.rst

@@ -8,7 +8,7 @@ This library provides the Flake8 plugin ``flake8-encodings``  to identify incorr
 Flake8 codes
 --------------
 
-**ENC00X**: checks for :func:`open`, :func:`builtins.open <open>` and :func:`io.open`.
+:bold-title:`ENC00X`: checks for :func:`open`, :func:`builtins.open <open>` and :func:`io.open`.
 
 .. flake8-codes:: flake8_encodings
 
@@ -19,17 +19,19 @@ Flake8 codes
 
 ``ENC003`` and ``ENC004`` are used in cases where the encoding is omitted (or is explicitly :py:obj:`None`) but the mode cannot be determined. The file might be opened in binary mode, in which case the encoding argument is ignored, or in text mode, in which case an encoding should be given.
 
-**ENC01X**: checks for :meth:`configparser.ConfigParser.read`.
+
+:bold-title:`ENC01X`: checks for :meth:`configparser.ConfigParser.read`.
 
 .. flake8-codes:: flake8_encodings
 
 	ENC011
 	ENC012
 
 .. versionadded:: 0.2.0
-.. versionchanged:: 0.4.0  These codes now require the classes extra to be installed [1]_.
+.. versionchanged:: 0.4.0  These codes now require the ``classes`` extra to be installed [1]_.
+
 
-**ENC02X**: checks for :meth:`pathlib.Path.open`, :meth:`read_text() <pathlib.Path.read_text>` and :meth:`write_text() <pathlib.Path.write_text>`.
+:bold-title:`ENC02X`: checks for :meth:`pathlib.Path.open`, :meth:`read_text() <pathlib.Path.read_text>` and :meth:`write_text() <pathlib.Path.write_text>`.
 
 .. flake8-codes:: flake8_encodings
 
@@ -41,7 +43,7 @@ Flake8 codes
 	ENC026
 
 .. versionadded:: 0.3.0
-.. versionchanged:: 0.4.0  These codes now require the classes extra to be installed [1]_.
+.. versionchanged:: 0.4.0  These codes now require the ``classes`` extra to be installed [1]_.
 
 .. [1] Install using ``python3 -m pip install flake8-encodings[classes]``
 

pyproject.toml

@@ -76,6 +76,7 @@ extensions = [
     "seed_intersphinx_mapping",
     "sphinx_toolbox.pre_commit",
     "sphinx_toolbox.flake8",
+    "sphinx_toolbox_experimental.html_section",
 ]
 sphinxemoji_style = "twemoji"
 gitstamp_fmt = "%d %b %Y"

repo_helper.yml

@@ -38,6 +38,7 @@ classifiers:
 extra_sphinx_extensions:
  - sphinx_toolbox.pre_commit
  - sphinx_toolbox.flake8
+ - sphinx_toolbox_experimental.html_section
 
 entry_points:
   flake8.extension: