Vishesh 'ironeagle' Bangotra
8c6c46caf2
- add build_wiki_nav deriving MkDocs nav from docs/wiki file structure (index.md -> Home, numeric prefixes stripped and title-cased, nested dirs become groups, natural ordering) - add --wiki / --wiki-dir to build; wiki-only builds need no --module - merge wiki nav before generated lib/api nav; wiki Home replaces the nav spec Home entry - add mkdocs.wiki.yml template fragment and nav/cli tests - dogfood doc-forge's own docs/wiki and regenerate site output
39 lines
1.0 KiB
Python
39 lines
1.0 KiB
Python
"""
|
||
Navigation layer for doc-forge.
|
||
|
||
The ``docforge.nav`` package manages the relationship between the logical
|
||
documentation structure defined by the user and the physical documentation
|
||
files generated on disk.
|
||
|
||
---
|
||
|
||
Workflow
|
||
--------
|
||
|
||
1. **Specification** – Users define navigation intent in ``docforge.nav.yml``.
|
||
2. **Resolution** – ``resolve_nav`` expands patterns and matches them against
|
||
generated Markdown files.
|
||
3. **Emission** – ``MkDocsNavEmitter`` converts the resolved structure into
|
||
the YAML navigation format required by ``mkdocs.yml``.
|
||
|
||
This layer separates documentation organization from the underlying source
|
||
code layout, enabling flexible grouping, ordering, and navigation structures
|
||
independent of module hierarchy.
|
||
|
||
---
|
||
"""
|
||
|
||
from .spec import NavSpec, load_nav_spec
|
||
from .resolver import ResolvedNav, resolve_nav
|
||
from .mkdocs import MkDocsNavEmitter
|
||
from .wiki import build_wiki_nav
|
||
|
||
__all__ = [
|
||
"NavSpec",
|
||
"ResolvedNav",
|
||
"MkDocsNavEmitter",
|
||
"build_wiki_nav",
|
||
"resolve_nav",
|
||
"load_nav_spec",
|
||
]
|