Welcome to vuer-doc-boilerplate｣

A documentation boilerplate with Sphinx, ReadTheDocs, PyPI publishing, and Claude Code skills.

Installation

pip install 'vuer-doc-boilerplate==0.1.0'

Quick Start

from vuer_doc_boilerplate import hello
hello()

Commands

# Setup
pip install -e ".[dev]"     # Install for development

# Documentation
make preview                # Preview docs with auto-reload
make docs                   # Build and serve docs

# Testing
make test                   # Run tests

# Publishing
make wheel                  # Build wheel
make publish                # Build and upload to PyPI
make release msg="v0.0.2"   # Create git tags

Claude Skills

# Install plugin
/plugin marketplace add vuer-ai/vuer-doc-boilerplate
/plugin install vuer-doc-boilerplate@vuer-ai-vuer-doc-boilerplate

# Or copy skills manually
cp -r .claude/skills/mypackage your-project/.claude/skills/

# Or reference in CLAUDE.md
# - mypackage: https://raw.githubusercontent.com/vuer-ai/vuer-doc-boilerplate/main/.claude/skills/mypackage/SKILL.md

For details on creating and updating skills, see Claude Skills and Development Workflow.