nav submodule
This commit is contained in:
27
docforge/nav/mkdocs.pyi
Normal file
27
docforge/nav/mkdocs.pyi
Normal file
@@ -0,0 +1,27 @@
|
||||
from typing import Dict, List, Any
|
||||
|
||||
from docforge.nav.resolver import ResolvedNav
|
||||
|
||||
|
||||
class MkDocsNavEmitter:
|
||||
"""
|
||||
Converts a ResolvedNav into MkDocs-compatible `nav` data.
|
||||
"""
|
||||
|
||||
def emit(self, nav: ResolvedNav) -> List[Dict[str, Any]]:
|
||||
"""
|
||||
Emit a structure suitable for insertion into mkdocs.yml.
|
||||
|
||||
Example return value:
|
||||
|
||||
[
|
||||
{"Home": "openapi_first/index.md"},
|
||||
{
|
||||
"Core": [
|
||||
{"OpenAPI-First App": "openapi_first/app.md"},
|
||||
...
|
||||
]
|
||||
}
|
||||
]
|
||||
"""
|
||||
...
|
||||
Reference in New Issue
Block a user