10
10
:license: BSD, see LICENSE for details.
11
11
"""
12
12
13
+ from __future__ import annotations
14
+
13
15
import gzip
14
16
import re
15
17
from os import path
16
- from typing import TYPE_CHECKING , Any , Dict
18
+ from typing import TYPE_CHECKING , Any
17
19
18
20
from docutils import nodes
19
21
from sphinx import addnodes
30
32
except ImportError :
31
33
import lxml .etree as etree # type: ignore
32
34
33
-
34
35
if TYPE_CHECKING :
35
- # For type annotation
36
36
from pathlib import Path
37
- from typing import List # NOQA
38
37
39
38
__version__ = '1.0.3'
40
39
__version_info__ = (1 , 0 , 3 )
@@ -64,18 +63,15 @@ class DevhelpBuilder(StandaloneHTMLBuilder):
64
63
# don't add sidebar etc.
65
64
embedded = True
66
65
67
- def init (self ):
68
- # type: () -> None
66
+ def init (self ) -> None :
69
67
super ().init ()
70
68
self .out_suffix = '.html'
71
69
self .link_suffix = '.html'
72
70
73
- def handle_finish (self ):
74
- # type: () -> None
71
+ def handle_finish (self ) -> None :
75
72
self .build_devhelp (self .outdir , self .config .devhelp_basename )
76
73
77
- def build_devhelp (self , outdir , outname ):
78
- # type: (Path, str) -> None
74
+ def build_devhelp (self , outdir : Path , outname : str ) -> None :
79
75
logger .info (__ ('dumping devhelp index...' ))
80
76
81
77
# Basic info
@@ -92,8 +88,7 @@ def build_devhelp(self, outdir, outname):
92
88
tocdoc = self .env .get_and_resolve_doctree (
93
89
self .config .master_doc , self , prune_toctrees = False )
94
90
95
- def write_toc (node , parent ):
96
- # type: (nodes.Node, etree.Element) -> None
91
+ def write_toc (node : nodes .Node , parent : etree .Element ) -> None :
97
92
if isinstance (node , addnodes .compact_paragraph ) or \
98
93
isinstance (node , nodes .bullet_list ):
99
94
for subnode in node :
@@ -114,8 +109,7 @@ def write_toc(node, parent):
114
109
functions = etree .SubElement (root , 'functions' )
115
110
index = IndexEntries (self .env ).create_index (self )
116
111
117
- def write_index (title , refs , subitems ):
118
- # type: (str, List[Any], Any) -> None
112
+ def write_index (title : str , refs : list [Any ], subitems : Any ) -> None :
119
113
if len (refs ) == 0 :
120
114
pass
121
115
elif len (refs ) == 1 :
@@ -143,7 +137,7 @@ def write_index(title, refs, subitems):
143
137
tree .write (f , 'utf-8' ) # type: ignore
144
138
145
139
146
- def setup (app : Sphinx ) -> Dict [str , Any ]:
140
+ def setup (app : Sphinx ) -> dict [str , Any ]:
147
141
app .setup_extension ('sphinx.builders.html' )
148
142
app .add_builder (DevhelpBuilder )
149
143
app .add_message_catalog (__name__ , path .join (package_dir , 'locales' ))
0 commit comments