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
|
"""A sphinx extension that allows the project toctree to be defined in a single file."""
__version__ = "1.0.1"
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from sphinx.application import Sphinx
def setup(app: "Sphinx") -> dict:
"""Initialize the Sphinx extension."""
from .events import (
InsertToctrees,
TableofContents,
add_changed_toctrees,
ensure_index_file,
parse_toc_to_env,
)
# variables
app.add_config_value("external_toc_path", "_toc.yml", "env")
app.add_config_value("external_toc_exclude_missing", False, "env")
# Note: this needs to occur after merge_source_suffix event (priority 800)
# this cannot be a builder-inited event, since if we change the master_doc
# it will always mark the config as changed in the env setup and re-build everything
app.connect("config-inited", parse_toc_to_env, priority=900)
app.connect("env-get-outdated", add_changed_toctrees)
app.add_directive("tableofcontents", TableofContents)
app.add_transform(InsertToctrees)
app.connect("build-finished", ensure_index_file)
return {"version": __version__, "parallel_read_safe": True}
|
