diff --git a/docs/conf.py b/docs/conf.py index 0157ce65..ae0196b7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,3 @@ -"""Configuration file for the Sphinx documentation builder. - -This file only contains a selection of the most common options. For a full list see the -documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html -""" - from __future__ import annotations from sphinx_api_relink.helpers import get_package_version diff --git a/pyproject.toml b/pyproject.toml index e0d30842..8d5ebd36 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -304,6 +304,7 @@ known-first-party = ["repoma"] "S113", "T201", ] +"docs/conf.py" = ["D100"] "setup.py" = ["D100"] "tests/*" = [ "D", diff --git a/src/repoma/check_dev_files/ruff.py b/src/repoma/check_dev_files/ruff.py index 5efd22ee..82f27c44 100644 --- a/src/repoma/check_dev_files/ruff.py +++ b/src/repoma/check_dev_files/ruff.py @@ -474,6 +474,13 @@ def _update_ruff_per_file_ignores(has_notebooks: bool) -> None: "S113", # requests call without timeout } minimal_settings[key] = __merge_rules(default_ignores, settings.get(key, [])) + conf_path = f"{docs_dir}/conf.py" + if os.path.exists(conf_path): + key = f"{conf_path}" + default_ignores = { + "D100", # no module docstring + } + minimal_settings[key] = __merge_rules(default_ignores, settings.get(key, [])) if os.path.exists("setup.py"): minimal_settings["setup.py"] = to_toml_array(["D100"]) tests_dir = "tests"