Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DX: ignore missing module docstring in conf.py #264

Merged
merged 1 commit into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,7 @@ known-first-party = ["repoma"]
"S113",
"T201",
]
"docs/conf.py" = ["D100"]
"setup.py" = ["D100"]
"tests/*" = [
"D",
Expand Down
7 changes: 7 additions & 0 deletions src/repoma/check_dev_files/ruff.py
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,13 @@
"S113", # requests call without timeout
}
minimal_settings[key] = __merge_rules(default_ignores, settings.get(key, []))
conf_path = f"{docs_dir}/conf.py"

Check warning on line 477 in src/repoma/check_dev_files/ruff.py

View check run for this annotation

Codecov / codecov/patch

src/repoma/check_dev_files/ruff.py#L477

Added line #L477 was not covered by tests
if os.path.exists(conf_path):
key = f"{conf_path}"
default_ignores = {

Check warning on line 480 in src/repoma/check_dev_files/ruff.py

View check run for this annotation

Codecov / codecov/patch

src/repoma/check_dev_files/ruff.py#L479-L480

Added lines #L479 - L480 were not covered by tests
"D100", # no module docstring
}
minimal_settings[key] = __merge_rules(default_ignores, settings.get(key, []))

Check warning on line 483 in src/repoma/check_dev_files/ruff.py

View check run for this annotation

Codecov / codecov/patch

src/repoma/check_dev_files/ruff.py#L483

Added line #L483 was not covered by tests
if os.path.exists("setup.py"):
minimal_settings["setup.py"] = to_toml_array(["D100"])
tests_dir = "tests"
Expand Down
Loading