1
Fork 0
mirror of https://github.com/RGBCube/GitHubWrapper synced 2025-05-14 13:15:00 +00:00
GitHubWrapper/docs/extensions/nitpick_file_ignorer.py
RGBCube f6b9852167 Cleaned up docs/
- Linted
- Changed Github-Api-Wrapper to GitHub-API-Wrapper
2022-06-25 14:07:43 +03:00

21 lines
679 B
Python

import logging
from sphinx.application import Sphinx
from sphinx.util import logging as sphinx_logging
class NitpickFileIgnorer(logging.Filter):
def __init__(self, app: Sphinx) -> None:
self.app = app
super().__init__()
def filter(self, record: sphinx_logging.SphinxLogRecord) -> bool:
if getattr(record, "type", None) == "ref":
return record.location.get("refdoc") not in self.app.config.nitpick_ignore_files
return True
def setup(app: Sphinx):
app.add_config_value("nitpick_ignore_files", [], "")
f = NitpickFileIgnorer(app)
sphinx_logging.getLogger("sphinx.transforms.post_transforms").logger.addFilter(f)