Vishesh 'ironeagle' Bangotra
06ffd2febd
Squash-merge lib-standardisation: adopt repo standards across packaging, tooling, docs, and CI. - standardize pyproject.toml (canonical packaging, lint config, extras, GSDFC pydoclint) - add py.typed marker, modernize type hints and Google-style docstrings - nest generated docs under docs/lib and docs/mcp; add hand-written wiki - adopt standard Type A PyPI CI pipeline (tag==version guard + quality gate) - promote generated CHANGELOG.md; bump version to 0.0.7
34 lines
1.0 KiB
Python
34 lines
1.0 KiB
Python
from collections.abc import Iterable
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
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 build_lib_nav(
|
|
nav_file: Path,
|
|
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,
|
|
docs_dir: str,
|
|
site_dir: str,
|
|
template: Path | None = None,
|
|
site_description: str | None = None,
|
|
site_author: str | None = None,
|
|
theme_icon: dict[str, str] | None = None,
|
|
) -> None: ...
|
|
def build_configs(yml_paths: Iterable[Path]) -> None: ...
|
|
def serve(mkdocs_yml: Path) -> None: ...
|