Build site.
build(options)
Build the site.
Source code in src/build.py
30 31 32 33 34 35 36 37 38 39 40 41 42 | |
_build_page(config, env, slug, src_path)
Handle a Markdown file.
Source code in src/build.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 | |
_build_other(config, src_path)
Handle non-Markdown file.
Source code in src/build.py
73 74 75 76 | |
_fill_element_numbers(dst_path, doc, prefix, known, text)
Fill in cross-reference numbers.
Source code in src/build.py
79 80 81 82 83 84 85 86 87 88 89 90 | |
_find_files(config)
Find section files and other files.
Source code in src/build.py
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 | |
_get_slug_from_link(raw)
Convert '@/something/' to 'something'.
Source code in src/build.py
112 113 114 115 | |
_is_interesting_file(config, excludes, filepath)
Is this file worth copying over?
Source code in src/build.py
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | |
_load_configuration(options)
Load configuration and combine with options.
Source code in src/build.py
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | |
_load_glossary(src_path)
Load glossary keys and terms.
Source code in src/build.py
171 172 173 174 175 176 | |
_load_order(src_path)
Determine section order from README.md.
Source code in src/build.py
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | |
_load_order_section(doc, selector, labeller)
Load a section of the table of contents from README.md DOM.
Source code in src/build.py
199 200 201 202 203 204 205 206 207 208 209 | |
_make_context(config, slug)
Make rendering context for a particular file.
Source code in src/build.py
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | |
_make_element_numbers(config, dst_path, doc, outer_tag, inner_tag, prefix, text)
Build element numbers, inserting along the way.
Source code in src/build.py
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 | |
_make_output_path(config, src_path, suffix=None)
Generate output file path.
Source code in src/build.py
273 274 275 276 277 278 279 280 281 282 | |
_make_root_prefix(config, path)
Create prefix to root for path.
Source code in src/build.py
285 286 287 288 289 290 | |
_patch_bibliography_links(config, dst_path, doc)
Convert b: bibliography links.
Source code in src/build.py
293 294 295 | |
_patch_figure_numbers(config, dst_path, doc)
Insert figure numbers.
Source code in src/build.py
298 299 300 301 302 303 | |
_patch_glossary_links(config, dst_path, doc)
Convert g: glossary links.
Source code in src/build.py
306 307 308 | |
_patch_pre_code_classes(config, dst_path, doc)
Add language classes to
elements.
Source code in src/build.py
311
312
313
314
315
def _patch_pre_code_classes(config, dst_path, doc):
"""Add language classes to <pre> elements."""
for node in doc.select("pre>code"):
cls = node.get("class", [])
node.parent["class"] = node.parent.get("class", []) + cls
_patch_root_links(config, dst_path, doc)
Convert @ links to relative path to root.
Source code in src/build.py
318 319 320 321 322 323 324 325 326 327 328 329 330 | |
_patch_special_link(config, dst_path, doc, prefix, stem, change_text)
Patch specially-prefixed links.
Source code in src/build.py
333 334 335 336 337 338 339 340 341 342 | |
_patch_table_numbers(config, dst_path, doc)
Insert figure numbers.
Source code in src/build.py
345 346 347 348 349 350 | |
_patch_terms_defined(config, dst_path, doc)
Insert terms defined where requested.
Source code in src/build.py
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | |
_patch_title(config, dst_path, doc)
Make sure the HTML title element is set.
Source code in src/build.py
381 382 383 384 385 386 387 388 389 | |