diff --git a/.rumdl.toml b/.rumdl.toml deleted file mode 100644 index 84b6d0337..000000000 --- a/.rumdl.toml +++ /dev/null @@ -1,30 +0,0 @@ -[global] -flavor = "mkdocs" -include = ["**/*.md"] -exclude = ["template.md",] -respect-gitignore = true -force-exclude = true - -# Disable rules: -# MD013: Line length - flagging on mkdocstrings content -# MD014: Forces commands in codeblocks to show output -# MD042: Empty link - buggy, still flagging on valid MkDocs formatting -# MD052: Reference link not found - buggy, flagging on valis MkDocs links -disable = ["MD014", "MD042", "MD052"] - -[per-file-ignores] -"changes/**/*.md" = ["MD041"] - -[MD013] # Line length -line_length = 999999 # Force reflow to paragraph content to remove linebreaks -reflow = true -reflow_mode = "normalize" - -[MD026] # Remove punctuation at the end of headings -punctuation = ",;:" - -[MD033] # No inline HTML -allowed_elements = ["nospell",] # pyspelling inline disable tag - -[MD046] -style = "fenced" diff --git a/changes/2633.misc.md b/changes/2633.misc.md new file mode 100644 index 000000000..6313af789 --- /dev/null +++ b/changes/2633.misc.md @@ -0,0 +1 @@ +Configuration for rumdl has been moved from a separate file into pyproject.toml. diff --git a/pyproject.toml b/pyproject.toml index fba03ac49..d75518a9d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -274,6 +274,37 @@ ignore = [ "src/briefcase/bootstraps/*" = ["E501"] "src/briefcase/platforms/*" = ["E501"] +[tool.rumdl] +flavor = "mkdocs" +include = ["**/*.md"] +exclude = ["template.md",] +respect-gitignore = true +force-exclude = true + +# Disable rules: +# MD013: Line length - flagging on mkdocstrings content +# MD014: Forces commands in codeblocks to show output +# MD042: Empty link - buggy, still flagging on valid MkDocs formatting +# MD052: Reference link not found - buggy, flagging on valis MkDocs links +disable = ["MD014", "MD042", "MD052"] + +[tool.rumdl.per-file-ignores] +"changes/**/*.md" = ["MD041"] + +[tool.rumdl.MD013] # Line length +line_length = 999999 # Force reflow to paragraph content to remove linebreaks +reflow = true +reflow_mode = "normalize" + +[tool.rumdl.MD026] # Remove punctuation at the end of headings +punctuation = ",;:" + +[tool.rumdl.MD033] # No inline HTML +allowed_elements = ["nospell",] # pyspelling inline disable tag + +[tool.rumdl.MD046] +style = "fenced" + [tool.setuptools_scm] # To enable SCM versioning, we need an empty tool configuration for setuptools_scm