skills.rest
lemeb
lemebCOMMUNITY
Explore all skills by this author →
GitHub

doc

Build and validate MkDocs documentation with spell-check and module tracking.

Updated May 24, 2025
Search Tags:#documentation#validation#build#docstrings#docs#mkdocs#spell-check
One-click install
npx skills add https://github.com/lemeb/python-library-cookiecutter --skill doc-lemeb
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc
Source: https://github.com/lemeb/python-library-cookiecutter/tree/main/%7B%7Bcookiecutter.project_slug%7D%7D/.claude/skills/doc
Command: npx skills add https://github.com/lemeb/python-library-cookiecutter --skill doc-lemeb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates building and validating project documentation to ensure docstrings and formatting meet standards.

Core Features & Use Cases

  • Documentation build and validation using make doc to produce consistent docs.
  • Spell-check management: update project-words.txt when new terms appear.
  • Module documentation tracking: ensure docs/api entries and mkdocs.yml nav reflect new modules.

Quick Start

Run make doc to build the documentation and fix any spell-check or nav issues until the build passes

Frequently Asked Questions about doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate documentation build and validation for Python MkDocs projects?▼

To automate documentation build and validation, run make doc to compile your MkDocs site, enforce docstring standards, and verify formatting so the build completes successfully without manual checks.

What is the best way to track new modules in MkDocs nav and API docs?▼

Tracking new modules in MkDocs nav requires updating mkdocs.yml entries and adding corresponding docs/api paths, which this automation verifies to ensure your module documentation stays synchronized with your codebase.

Why does spell-check fail when I add new terms to my documentation build?▼

Spell-check fails during your documentation build when new terms appear that are not tracked, requiring you to update project-words.txt to whitelist them and allow the build to pass successfully.

Does this documentation validation work with Python projects using MkDocs?▼

Yes, this documentation validation is designed specifically for Python projects using MkDocs, applying spell-check workflows and docstring formatting standards to ensure the make doc build completes without errors.

How do I fix MkDocs nav issues when the documentation build fails?▼

Fix MkDocs nav issues during a failed build by ensuring mkdocs.yml accurately reflects your module structure, adding missing docs/api entries for new modules, and re-running make doc until validation passes.

Related Skills

Explore More Content & Communication Skills→
carrotwaxrcarrotwaxr
37

updating-docs

Enforce MkDocs structure and generate TypeScript API reference documentation.

Community
Intermediate
kettleofketchupkettleofketchup

zensical

Migrate mkdocs-material projects to Zensical and manage their documentation.

Community
Intermediate
castackscastacks
84

update-documentation

Update README templates, mkdocs.yml navigation, and mermaid diagrams after adding a module.

Official
Intermediate
windyskywindysky

moai-docs-generation

Generate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.

Community
Advanced