feat: build each doc kind with its own MkDocs config and site
This commit is contained in:
@@ -1,5 +1,6 @@
|
||||
from collections.abc import Iterable
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
def generate_sources(
|
||||
module: str,
|
||||
@@ -8,16 +9,25 @@ def generate_sources(
|
||||
module_is_source: bool | None = None,
|
||||
readme_dir: Path | None = None,
|
||||
) -> None: ...
|
||||
def generate_config(
|
||||
docs_dir: Path,
|
||||
def build_lib_nav(
|
||||
nav_file: Path,
|
||||
template: Path | None,
|
||||
docs_root: Path,
|
||||
) -> tuple[list[dict[str, Any]], dict[str, str] | None]: ...
|
||||
def build_wiki_nav_block(wiki_dir: Path) -> list[dict[str, Any]]: ...
|
||||
def load_spec_icon(nav_file: Path) -> dict[str, str] | None: ...
|
||||
def _strip_scope(value: object, scope: str) -> object: ...
|
||||
def generate_site_config(
|
||||
kind: str,
|
||||
kind_root: Path,
|
||||
nav_block: list[dict[str, Any]],
|
||||
out: Path,
|
||||
site_name: str,
|
||||
modes: Iterable[str] | None = None,
|
||||
docs_dir: str,
|
||||
site_dir: str,
|
||||
template: Path | None = None,
|
||||
site_description: str | None = None,
|
||||
site_author: str | None = None,
|
||||
wiki_dir: Path | None = None,
|
||||
theme_icon: dict[str, str] | None = None,
|
||||
) -> None: ...
|
||||
def build(mkdocs_yml: Path) -> None: ...
|
||||
def build_configs(yml_paths: Iterable[Path]) -> None: ...
|
||||
def serve(mkdocs_yml: Path) -> None: ...
|
||||
|
||||
Reference in New Issue
Block a user