preview
nbdev_mkdocs.mkdocs.preview(root_path: str, use_relative_doc_links: bool, port: Optional[int] = None) -> None
¤
Preview the mkdocs documentation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
root_path |
str
|
The root path of the documentation. |
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. |
required |
port |
Optional[int]
|
The port to serve the documentation on. |
None
|
Note
The above docstring is autogenerated by docstring-gen library (https://github.com/airtai/docstring-gen)
Source code in nbdev_mkdocs/mkdocs.py
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 |
|