Updated docs

Author: domdfcoding

doc-source/conf.py

@@ -46,6 +46,8 @@
 		'sphinxcontrib.default_values',
 		'sphinxcontrib.toctree_plus',
 		'seed_intersphinx_mapping',
+		'sphinx_toolbox.pre_commit',
+		'sphinx_toolbox.flake8',
 		]
 
 sphinxemoji_style = 'twemoji'

doc-source/index.rst

@@ -125,7 +125,8 @@ Installation
 Usage
 --------
 
-This library provides the Flake8 plugin ``flake8-dunder-all`` as well as the ``ensure-dunder-all``,script which adds ``__all__`` to files that require it.
+This library provides the Flake8 plugin ``flake8-dunder-all`` as well as the
+``ensure-dunder-all`` script which adds ``__all__`` to files that require it.
 
 
 Using the Flake8 plugin as a pre-commit hook
@@ -137,13 +138,7 @@ See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
 
 Sample `.pre-commit-config.yaml`:
 
-.. code-block:: yaml
-
-	 - repo: https://gitlab.com/pycqa/flake8
-	   rev: 3.8.1
-	   hooks:
-	    - id: flake8
-	      additional_dependencies: [flake8-dunder-all==0.0.4]
+.. pre-commit:flake8:: 0.0.4
 
 
 Using the script as a pre-commit hook
@@ -155,12 +150,8 @@ See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
 
 Sample `.pre-commit-config.yaml`:
 
-.. code-block:: yaml
-
-	 - repo: https://github.com/domdfcoding/flake8-dunder-all
-	   rev: v0.0.4
-	   hooks:
-	    - id: ensure-dunder-all
+.. pre-commit::
+	:rev: v0.0.4
 
 
 .. toctree::
@@ -175,6 +166,11 @@ Sample `.pre-commit-config.yaml`:
 	plugin
 	script
 	API Reference<docs>
+
+.. toctree::
+	:maxdepth: 3
+	:caption: Contributing
+
 	contributing
 	Source
 

doc-source/plugin.rst

@@ -5,8 +5,6 @@ Flake8 Plugin
 Flake8 codes
 --------------
 
-============== ====================================
-Code           Description
-============== ====================================
-DALL000        DALL000 Module lacks __all__.
-============== ====================================
+.. flake8-codes:: flake8_dunder_all
+
+	DALL000

doc-source/requirements.txt

@@ -1,14 +1,16 @@
 autodocsumm>=0.2.0
-default_values>=0.2.0
-domdf_sphinx_theme>=0.1.0
-extras_require>=0.2.0
-seed_intersphinx_mapping>=0.1.1
+default-values>=0.2.0
+domdf-sphinx-theme>=0.1.0
+extras-require>=0.2.0
+pyyaml>=5.3.1
+seed-intersphinx-mapping>=0.1.1
 sphinx>=3.0.3
 sphinx-copybutton>=0.2.12
 sphinx-notfound-page>=0.5
 sphinx-prompt>=1.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=1.5.1
+sphinx-toolbox>=1.6.1
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
-toctree_plus>=0.0.4
+tabulate>=0.8.7
+toctree-plus>=0.0.4

repo_helper.yml

@@ -37,3 +37,7 @@ classifiers:
 console_scripts:
   - "ensure_dunder_all=flake8_dunder_all.__main__:main"
   - "ensure-dunder-all=flake8_dunder_all.__main__:main"
+
+extra_sphinx_extensions:
+  - sphinx_toolbox.pre_commit
+  - sphinx_toolbox.flake8

tox.ini

@@ -93,6 +93,7 @@ deps =
     flake8-builtins
     pygments
     git+https://github.com/domdfcoding/flake8-quotes.git
+    git+https://github.com/PyCQA/pydocstyle@5118faa7173b0e5bbc230c4adf628758e13605bf
 commands = flake8 flake8_dunder_all tests
 
 [testenv:yapf]
@@ -156,6 +157,11 @@ rst-roles =
     issue
     asset
     confval
+    data
+    py:data
+    py:exc
+    deco
+    regex
 rst-directives =
     envvar
     exception
@@ -176,6 +182,9 @@ rst-directives =
     rst:directive:option
     rst:role
     pre-commit-shield
+    py:data
+    py:method
+    py:classmethod
 per-file-ignores = tests/*: D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
 pytest-parametrize-names-type = csv
 inline-quotes = "