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
24 lines
623 B
Python
24 lines
623 B
Python
from collections.abc import Iterable
|
|
from pathlib import Path
|
|
|
|
def generate_sources(
|
|
module: str,
|
|
docs_dir: Path,
|
|
project_name: str | None = None,
|
|
module_is_source: bool | None = None,
|
|
readme_dir: Path | None = None,
|
|
) -> None: ...
|
|
def generate_config(
|
|
docs_dir: Path,
|
|
nav_file: Path,
|
|
template: Path | None,
|
|
out: Path,
|
|
site_name: str,
|
|
modes: Iterable[str] | None = None,
|
|
site_description: str | None = None,
|
|
site_author: str | None = None,
|
|
wiki_dir: Path | None = None,
|
|
) -> None: ...
|
|
def build(mkdocs_yml: Path) -> None: ...
|
|
def serve(mkdocs_yml: Path) -> None: ...
|