Tag

documentation

Posts collected under this tag.

guide

Writing Python Docstrings for MkDocs

A compact, Markdown-first docstring style for Python projects that auto-generate API reference pages with MkDocs, keeping exact API facts close to code without duplicating them in guide pages.

mkdocspythondocstringsdocumentation
guide

Versioned MkDocs Docs with Mike, GitHub Pages, and a Custom Domain

A practical, opinionated walkthrough of the documentation strategy I use across my Python projects: versioned MkDocs output on a dedicated branch, Mike for release aliases, and GitHub Pages serving a custom domain.

mkdocsdocumentationmikegithub-pagesversioning