disnake

1
# SPDX-License-Identifier: MIT
2
from __future__ import annotations
3

4
import logging
5
from typing import TYPE_CHECKING
6

7
from sphinx.util import logging as sphinx_logging
8

9
if TYPE_CHECKING:
10
    from sphinx.application import Sphinx
11

12
    from ._types import SphinxExtensionMeta
13

14

15
class NitpickFileIgnorer(logging.Filter):
16
    def __init__(self, app: Sphinx) -> None:
17
        self.app = app
18
        super().__init__()
19

20
    def filter(self, record: sphinx_logging.SphinxLogRecord) -> bool:
21
        if getattr(record, "type", None) == "ref":
22
            return record.location.get("refdoc") not in self.app.config.nitpick_ignore_files
23
        return True
24

25

26
def setup(app: Sphinx) -> SphinxExtensionMeta:
27
    app.add_config_value("nitpick_ignore_files", [], "")
28
    f = NitpickFileIgnorer(app)
29
    sphinx_logging.getLogger("sphinx.transforms.post_transforms").logger.addFilter(f)
30

31
    return {
32
        "parallel_read_safe": True,
33
        "parallel_write_safe": True,
34
    }
35