1"""
2    sphinx.builders.dummy
3    ~~~~~~~~~~~~~~~~~~~~~
4
5    Do syntax checks, but no writing.
6
7    :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
8    :license: BSD, see LICENSE for details.
9"""
10
11from typing import Any, Dict, Set
12
13from docutils.nodes import Node
14
15from sphinx.application import Sphinx
16from sphinx.builders import Builder
17from sphinx.locale import __
18
19
20class DummyBuilder(Builder):
21    name = 'dummy'
22    epilog = __('The dummy builder generates no files.')
23
24    allow_parallel = True
25
26    def init(self) -> None:
27        pass
28
29    def get_outdated_docs(self) -> Set[str]:
30        return self.env.found_docs
31
32    def get_target_uri(self, docname: str, typ: str = None) -> str:
33        return ''
34
35    def prepare_writing(self, docnames: Set[str]) -> None:
36        pass
37
38    def write_doc(self, docname: str, doctree: Node) -> None:
39        pass
40
41    def finish(self) -> None:
42        pass
43
44
45def setup(app: Sphinx) -> Dict[str, Any]:
46    app.add_builder(DummyBuilder)
47
48    return {
49        'version': 'builtin',
50        'parallel_read_safe': True,
51        'parallel_write_safe': True,
52    }
53