Get extra known directives from config file

Author: AA-Turner

pyproject.toml

@@ -23,6 +23,7 @@ requires-python = ">= 3.7"
 dependencies = [
     "regex",
     "polib",
+    "tomli>=2; python_version < '3.11'",
 ]
 dynamic = ["version"]
 

sphinxlint/__main__.py

@@ -7,6 +7,8 @@
 from itertools import chain, starmap
 
 from sphinxlint import check_file
+from sphinxlint import rst
+from sphinxlint.config import get_config
 from sphinxlint.checkers import all_checkers
 from sphinxlint.sphinxlint import CheckersOptions
 
@@ -113,6 +115,11 @@ def walk(path, ignore_list):
 
 
 def main(argv=None):
+    config = get_config()
+
+    # Append extra directives
+    rst.DIRECTIVES_CONTAINING_ARBITRARY_CONTENT.extend(config.get("known_directives", []))
+
     enabled_checkers, args = parse_args(argv)
     options = CheckersOptions.from_argparse(args)
     if args.list:

sphinxlint/checkers.py

@@ -136,8 +136,9 @@ def check_directive_with_three_dots(file, lines, options=None):
     Bad:  ... versionchanged:: 3.6
     Good:  .. versionchanged:: 3.6
     """
+    three_dot_directive_re = rst.three_dot_directive_re()
     for lno, line in enumerate(lines, start=1):
-        if rst.THREE_DOT_DIRECTIVE_RE.search(line):
+        if three_dot_directive_re.search(line):
             yield lno, "directive should start with two dots, not three."
 
 
@@ -148,8 +149,9 @@ def check_directive_missing_colons(file, lines, options=None):
     Bad:  .. versionchanged 3.6.
     Good: .. versionchanged:: 3.6
     """
+    seems_directive_re = rst.seems_directive_re()
     for lno, line in enumerate(lines, start=1):
-        if rst.SEEMS_DIRECTIVE_RE.search(line):
+        if seems_directive_re.search(line):
             yield lno, "comment seems to be intended as a directive"
 
 

sphinxlint/config.py

@@ -0,0 +1,28 @@
+import sys
+from os.path import isfile
+from typing import Any
+
+if sys.version_info[:2] >= (3, 11):
+    import tomllib
+else:
+    try:
+        import tomli as tomllib
+    except ImportError:
+        tomllib = None
+
+
+def _read_toml(filename: str) -> dict[str, Any]:
+    if tomllib is None:
+        return {}
+    with open(filename, "rb") as f:
+        return tomllib.load(f)
+
+
+def get_config() -> dict[str, Any]:
+    if isfile("sphinx.toml"):
+        table = _read_toml("sphinx.toml")
+    elif isfile("pyproject.toml"):
+        table = _read_toml("pyproject.toml")
+    else:
+        table = {}
+    return table.get("tool", {}).get("sphinx-lint", {})

sphinxlint/rst.py

@@ -132,12 +132,6 @@
     r"^\s*\.\. (" + "|".join(DIRECTIVES_CONTAINING_RST) + ")::"
 )
 
-ALL_DIRECTIVES = (
-    "("
-    + "|".join(DIRECTIVES_CONTAINING_RST + DIRECTIVES_CONTAINING_ARBITRARY_CONTENT)
-    + ")"
-)
-
 QUOTE_PAIRS = [
     "»»",  # Swedish
     "‘‚",  # Albanian/Greek/Turkish
@@ -184,6 +178,14 @@
 UNICODE_ALLOWED_AFTER_INLINE_MARKUP = r"[\p{Pe}\p{Pi}\p{Pf}\p{Pd}\p{Po}]"
 
 
+def get_all_directives() -> str:
+    return (
+        "("
+        + "|".join(DIRECTIVES_CONTAINING_RST + DIRECTIVES_CONTAINING_ARBITRARY_CONTENT)
+        + ")"
+    )
+
+
 def inline_markup_gen(start_string, end_string, extra_allowed_before=""):
     """Generate a regex matching an inline markup.
 
@@ -259,19 +261,24 @@ def inline_markup_gen(start_string, end_string, extra_allowed_before=""):
     rf"(^|\s)`:{SIMPLENAME}:{INTERPRETED_TEXT_RE.pattern}", flags=re.VERBOSE | re.DOTALL
 )
 
+
 # Find comments that look like a directive, like:
 # .. versionchanged 3.6
 # or
 # .. versionchanged: 3.6
 # as it should be:
 # .. versionchanged:: 3.6
-SEEMS_DIRECTIVE_RE = re.compile(rf"^\s*(?<!\.)\.\. {ALL_DIRECTIVES}([^a-z:]|:(?!:))")
+def seems_directive_re() -> re.Pattern[str]:
+    return re.compile(rf"^\s*(?<!\.)\.\. {get_all_directives()}([^a-z:]|:(?!:))")
+
 
 # Find directive prefixed with three dots instead of two, like:
 # ... versionchanged:: 3.6
 # instead of:
 # .. versionchanged:: 3.6
-THREE_DOT_DIRECTIVE_RE = re.compile(rf"\.\.\. {ALL_DIRECTIVES}::")
+def three_dot_directive_re() -> re.Pattern[str]:
+    return re.compile(rf"\.\.\. {get_all_directives()}::")
+
 
 # Find role used with double backticks instead of simple backticks like:
 # :const:``None``

sphinxlint/utils.py

@@ -177,7 +177,7 @@ def hide_non_rst_blocks(lines, hidden_block_cb=None):
 def type_of_explicit_markup(line):
     """Tell apart various explicit markup blocks."""
     line = line.lstrip()
-    if re.match(rf"\.\. {rst.ALL_DIRECTIVES}::", line):
+    if re.match(rf"\.\. {rst.get_all_directives()}::", line):
         return "directive"
     if re.match(r"\.\. \[[0-9]+\] ", line):
         return "footnote"