Add regex module to more_autodoc.

.isort.cfg

@@ -24,6 +24,7 @@ known_third_party =
     github
     html5lib
     hypothesis
+    importlib_resources
     pprint36
     pytest
     pytest_cov

MANIFEST.in

@@ -2,5 +2,6 @@ include __pkginfo__.py
 include LICENSE
 include requirements.txt
 prune **/__pycache__
+include sphinx_toolbox/more_autodoc/regex.css
 recursive-include sphinx_toolbox *.pyi
 include sphinx_toolbox/py.typed

doc-source/extensions/more_autodoc/regex.rst

@@ -0,0 +1,32 @@
+==========================================
+:mod:`~sphinx_toolbox.more_autodoc.regex`
+==========================================
+
+.. automodule:: sphinx_toolbox.more_autodoc.regex
+	:noindex:
+	:no-autosummary:
+	:no-members:
+
+
+API Reference
+--------------
+
+.. automodulesumm:: sphinx_toolbox.more_autodoc.regex
+	:member-order: bysource
+
+.. autoclass:: sphinx_toolbox.more_autodoc.regex.RegexDocumenter
+
+.. autoclass:: sphinx_toolbox.more_autodoc.regex.RegexParser
+	:exclude-members: AT_COLOUR,SUBPATTERN_COLOUR,IN_COLOUR,REPEAT_COLOUR,REPEAT_BRACE_COLOUR,CATEGORY_COLOUR,BRANCH_COLOUR,LITERAL_COLOUR,ANY_COLOUR
+
+.. autoclass:: sphinx_toolbox.more_autodoc.regex.TerminalRegexParser
+	:no-members:
+
+.. autoclass:: sphinx_toolbox.more_autodoc.regex.HTMLRegexParser
+	:no-members:
+
+.. automodule:: sphinx_toolbox.more_autodoc.regex
+	:no-docstring:
+	:no-autosummary:
+	:members: parse_regex_flags,no_formatting,span,setup
+	:member-order: bysource

repo_helper.yml

@@ -41,3 +41,6 @@ extra_sphinx_extensions:
 
 sphinx_conf_epilogue:
   - hide_none_rtype = True
+
+manifest_additional:
+  - include sphinx_toolbox/more_autodoc/regex.css

requirements.txt

@@ -4,6 +4,7 @@ beautifulsoup4>=4.9.1
 docutils>=0.16
 domdf_python_tools>=0.8.0
 html5lib>=1.1
+importlib_resources>=3.0.0
 requests>=2.24.0
 sphinx>=3.0.3
 sphinx-autodoc-typehints==1.11.0

sphinx_toolbox/more_autodoc/__init__.py

@@ -84,6 +84,7 @@ def setup(app: Sphinx) -> SphinxExtMetadata:
 	app.setup_extension("sphinx_toolbox.more_autodoc.variables")
 	app.setup_extension("sphinx_toolbox.more_autodoc.sourcelink")
 	app.setup_extension("sphinx_toolbox.more_autodoc.no_docstring")
+	app.setup_extension("sphinx_toolbox.more_autodoc.regex")
 
 	return {
 			"version": __version__,

sphinx_toolbox/more_autodoc/regex.css

@@ -0,0 +1,51 @@
+span.regex_literal {
+	color: dimgrey;
+}
+
+span.regex_at {
+	/*color: rgb(204, 120, 50)*/
+	color: orangered;
+}
+
+span.regex_repeat_brace {
+	/*color: rgb(204, 120, 50)*/
+	color: orangered;
+}
+
+span.regex_branch {
+	/*color: rgb(204, 120, 50)*/
+	color: orangered;
+}
+
+span.regex_subpattern {
+	/*color: indianred !* rgb(255, 150, 50) *!*/
+	color: dodgerblue /* rgb(255, 150, 50) */
+}
+
+span.regex_in {
+	/*color: rgb(255, 150, 50)*/
+	color: darkorange
+}
+
+span.regex_category {
+	/*color: rgb(255, 150, 50)*/
+	color: darkseagreen;
+}
+
+span.regex_repeat {
+	/*color: rgb(51, 204, 255)*/
+	color: orangered;
+}
+
+span.regex_any {
+	/*color: rgb(204, 120, 50)*/
+	color: orangered;
+}
+
+code.regex {
+	font-size: 80%;
+}
+
+span.regex {
+	font-weight: bold;
+}