Updated docs.

Author: domdfcoding

doc-source/codes.rst

@@ -2,8 +2,6 @@
 flake8 codes
 =================
 
-============== =====================================================================
-Code           Description
-============== =====================================================================
-SXL001         Double backticked variable should be a link to Python documentation.
-============== =====================================================================
+.. flake8-codes:: flake8_sphinx_links
+
+	SXL001

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

@@ -133,15 +133,9 @@ Use as a pre-commit hook
 
 See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
 
-Sample `.pre-commit-config.yaml`:
+Sample ``.pre-commit-config.yaml``:
 
-.. code-block:: yaml
-
-	 - repo: https://gitlab.com/pycqa/flake8
-	   rev: 3.8.1
-	   hooks:
-	    - id: flake8
-	      additional_dependencies: [flake8-sphinx-links==0.0.4]
+.. pre-commit:flake8:: 0.0.4
 
 
 .. toctree::
@@ -156,8 +150,13 @@ Sample `.pre-commit-config.yaml`:
 	codes
 	examples
 	API Reference<docs>
+
+.. toctree::
+	:maxdepth: 3
+	:caption: Contributing
+
+	contributing
 	Source
-	Building
 
 .. start links
 

doc-source/requirements.txt

@@ -1,14 +1,14 @@
 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
+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
+toctree-plus>=0.0.4

flake8_sphinx_links/__init__.py

@@ -42,8 +42,20 @@
 __version__: str = "0.0.4"
 __email__: str = "dominic@davis-foster.co.uk"
 
+__all__ = [
+		"SXL001",
+		"Visitor",
+		"Plugin",
+		"py_obj",
+		"py_obj_python",
+		"exc",
+		"class_",
+		"regex",
+		]
+
 SXL001: str = "SXL001 Double backticked strings should be a link to Python documentation."  # noqa: E501
 
+#: List of keywords that should become :file:`:py:obj:\`{<keyword>}\``
 py_obj: List[str] = [
 		"True",
 		"False",
@@ -58,7 +70,12 @@
 		]
 
 py_obj_python: List[str] = ["copyright"]
+"""
+List of keywords that should become :file:`:py:obj:\`python:{<keyword>}\``
+to prevent conflict with Sphinx objects.
+"""
 
+#: List of keywords that should become :file:`:py:exc:\`{<keyword>}\``
 exc: List[str] = [
 		"BaseException",
 		"Exception",
@@ -152,6 +169,7 @@
 
 all_objs: str = '|'.join(py_obj + py_obj_python + exc + class_)
 
+#: Regex to match keywords that should be Sphinx links.
 regex: Pattern = re.compile(fr"(``)({all_objs})(``)")
 
 

repo_helper.yml

@@ -37,5 +37,6 @@ classifiers:
   - 'Topic :: Software Development :: Libraries :: Python Modules'
   - "Topic :: Utilities"
 
-exclude_files:
-  - setup_cfg
+extra_sphinx_extensions:
+  - sphinx_toolbox.pre_commit
+  - sphinx_toolbox.flake8