blob: f025311e5ea849b0c87f33d27b63e77d896d701f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
"""Do syntax checks, but no writing."""
from __future__ import annotations
from typing import TYPE_CHECKING, Any
from sphinx.builders import Builder
from sphinx.locale import __
if TYPE_CHECKING:
from docutils.nodes import Node
from sphinx.application import Sphinx
class DummyBuilder(Builder):
name = 'dummy'
epilog = __('The dummy builder generates no files.')
allow_parallel = True
def init(self) -> None:
pass
def get_outdated_docs(self) -> set[str]:
return self.env.found_docs
def get_target_uri(self, docname: str, typ: str | None = None) -> str:
return ''
def prepare_writing(self, docnames: set[str]) -> None:
pass
def write_doc(self, docname: str, doctree: Node) -> None:
pass
def finish(self) -> None:
pass
def setup(app: Sphinx) -> dict[str, Any]:
app.add_builder(DummyBuilder)
return {
'version': 'builtin',
'parallel_read_safe': True,
'parallel_write_safe': True,
}
|
