reactive-firewall-org
diff --git a/‎.style.yapf
Lines changed: 402 additions & 0 deletions b/‎.style.yapf
Lines changed: 402 additions & 0 deletions
diff --git a/‎docs/conf.py
Lines changed: 42 additions & 46 deletions b/‎docs/conf.py
Lines changed: 42 additions & 46 deletions
diff --git a/‎docs/utils.py
Lines changed: 3 additions & 2 deletions b/‎docs/utils.py
Lines changed: 3 additions & 2 deletions
@@ -36,7 +36,6 @@
 	'v2.0'
 """
 
-
 import sys
 import os
 from urllib.parse import quote
@@ -72,17 +71,25 @@
 # for md us 'autodoc2' (pip install sphinx-autodoc2)
 # for rst use 'sphinx.ext.autodoc'
 extensions = [
-	"""sphinx.ext.napoleon""", """autodoc2""", """sphinx.ext.autosectionlabel""",
-	"""sphinx.ext.githubpages""", """myst_parser""", """sphinx_design""",
-	"""sphinx.ext.autosummary""", """sphinx.ext.doctest""", """sphinx.ext.todo""",
-	"""sphinx.ext.linkcode""", """sphinx.ext.viewcode""", """sphinx.ext.intersphinx""",
+	"""sphinx.ext.napoleon""",
+	"""autodoc2""",
+	"""sphinx.ext.autosectionlabel""",
+	"""sphinx.ext.githubpages""",
+	"""myst_parser""",
+	"""sphinx_design""",
+	"""sphinx.ext.autosummary""",
+	"""sphinx.ext.doctest""",
+	"""sphinx.ext.todo""",
+	"""sphinx.ext.linkcode""",
+	"""sphinx.ext.viewcode""",
+	"""sphinx.ext.intersphinx""",
 ]
 
 # for md auto-docs
 autodoc2_packages = [
+	"tests",
 	"multicast",
 	"tests.context",
-	"tests",
 ]
 
 autodoc2_render_plugin = "myst"
@@ -92,11 +99,11 @@
 
 # The suffix of source filenames.
 source_suffix = {
+	".yml": "yaml",
 	".md": "markdown",
 	".txt": "markdown",
-	".rst": "restructuredtext",
-	".yml": "yaml",
 	"Makefile": "makefile",
+	".rst": "restructuredtext",
 }
 
 # The encoding of source files. Official sphinx docs recommend utf-8-sig.
@@ -132,8 +139,18 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = [
-	"_build", ".github", ".circleci", "codecov_env", ".DS_Store", "**/.git", "dist",
-	"../tests/tests/**", "www", "**/docs", "../multicast/multicast/**", "*~"
+	"*~",
+	"www",
+	"dist",
+	"_build",
+	".github",
+	"**/docs",
+	"**/.git",
+	".DS_Store",
+	".circleci",
+	"codecov_env",
+	"../tests/tests/**",
+	"../multicast/multicast/**",
 ]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
@@ -161,7 +178,6 @@
 # pygments_style_dark ="monokai"
 pygments_style_dark = "github-dark"
 
-
 pygments_options = {
 	"""tabsize""": 4,
 	"""stripall""": False,
@@ -268,12 +284,11 @@
 # html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = "html"
+html_file_suffix = ".html"
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = "multicast_doc"
 
-
 # -- Options for MyST markdown parser -------------------------------------------
 # see https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html
 
@@ -340,13 +355,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-	(
-		"index",
-		"Documentation.tex",
-		"Multicast Documentation",
-		"reactive-firewall",
-		"manual"
-	),
+	("index", "Documentation.tex", "Multicast Documentation", "reactive-firewall", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -369,39 +378,29 @@
 # If false, no module index is generated.
 # latex_domain_indices = True
 
-
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-	(
-		"index",
-		"multicast",
-		"Multicast Documentation",
-		["reactive-firewall"],
-		1
-	)
-]
+man_pages = [("index", "multicast", "Multicast Documentation", ["reactive-firewall"], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
 
-
 # -- Options for Texinfo output ------------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
 	(
-		"index",
-		"Multicast",
-		"Multicast Documentation",
-		"reactive-firewall",
-		"Multicast",
-		"Multicast Python Module.",
-		"Miscellaneous"
+	"index",
+	"Multicast",
+	"Multicast Documentation",
+	"reactive-firewall",
+	"Multicast",
+	"Multicast Python Module.",
+	"Miscellaneous"
 	),
 ]
 
@@ -418,22 +417,19 @@
 
 linkcode_url_prefix: str = f"https://github.com/reactive-firewall/{project}"
 
+suffix = """/issues/%s"""
+
 extlinks = {
 	"""issue""": (
-		str("""{prefix}/{suffix}""").format(
-			prefix=linkcode_url_prefix, suffix="""/issues/%s"""
-		),
-		"""issue #%s"""
+	f"{linkcode_url_prefix}/{suffix}",
+	"""issue #%s"""
 	)
 }
 
 # try to link with official python3 documentation.
 # see https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html for more
 intersphinx_mapping = {
-	"""python""": (
-		"""https://docs.python.org/3""",
-		(None, """python-inv.txt""")
-	)
+	"""python""": ("""https://docs.python.org/3""", (None, """python-inv.txt"""))
 }
 
 
 
@@ -18,6 +18,7 @@
 
 import re
 
+
 def _validate_git_ref(ref: str) -> str:
 	"""
 	Validate if the provided string is a valid Git reference.
@@ -104,6 +105,6 @@ def slugify_header(s: str) -> str:
 			'cep-7-documentation-guide'
 	"""
 	# First, remove special characters and convert to lowercase
-	text = re.sub(r'[^\w\- ]', '', s).strip().lower()
+	text = re.sub(r'[^\w\- ]', "", s).strip().lower()
 	# Then replace consecutive spaces or dashes with a single dash
-	return re.sub(r'[-\s]+', '-', text)
+	return re.sub(r'[-\s]+', "-", text)