prepare
nbdev_mkdocs.mkdocs.prepare(root_path: str, use_relative_doc_links: bool = False, no_test: bool = False, no_mkdocs_build: bool = False) -> None
¤
Prepare mkdocs for serving
Parameters:
Name | Type | Description | Default |
---|---|---|---|
root_path |
str
|
The root path of the project |
required |
use_relative_doc_links |
bool
|
If set to True, relative links are added to symbol references in generated
documentation. Else, the value set in doc_host in settings.ini is added to symbol references in
generated documentation. This flag should be set to |
False
|
no_test |
bool
|
If set to False, the unit tests will be run, else they will be skipped |
False
|
no_mkdocs_build |
bool
|
If set to True, then the mkdocs build will be skipped. This flag
should be set to |
False
|
Note
The above docstring is autogenerated by docstring-gen library (https://github.com/airtai/docstring-gen)
Source code in nbdev_mkdocs/mkdocs.py
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 |
|