Skill v1.0.2

currentAutomated scan100/100

wdm0006/python-skills/documentation

1 files

──Details

PublishedSeptember 25, 2026 at 11:04 PM

Content Hashsha256:5313c2ac3dc0a1fe...

Git SHA954796b7fc28

Bump Typepatch

Compare with v1.0.1

──Files

Files (1 file, 3.3 KB)

SKILL.md3.3 KBactive

SKILL.md · 131 lines · 3.3 KB

version: "1.0.2" name: documenting-python-libraries description: Creates comprehensive Python library documentation including Google-style docstrings, Sphinx setup, API references, tutorials, and ReadTheDocs configuration. Use when writing docstrings, setting up Sphinx documentation, or creating user guides for Python libraries.

Python Library Documentation

Docstring Style (Google)

python

def encode(latitude: float, longitude: float, *, precision: int = 12) -> str:
    """Encode geographic coordinates to a quadtree string.
    Args:
        latitude: The latitude in degrees (-90 to 90).
        longitude: The longitude in degrees (-180 to 180).
        precision: Number of characters in output. Defaults to 12.
    Returns:
        A string representing the encoded location.
    Raises:
        ValidationError: If coordinates are out of valid range.
    Example:
        >>> encode(37.7749, -122.4194)
        '9q8yy9h7wr3z'
    """

Sphinx Quick Setup

bash

# Install
uv add --dev sphinx furo myst-parser sphinx-copybutton
 
# Initialize
sphinx-quickstart docs/

conf.py essentials:

python

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',  # Google docstrings
    'myst_parser',          # Markdown support
]
html_theme = 'furo'

pyproject.toml Dependencies

toml

[project.optional-dependencies]
docs = [
    "sphinx>=7.0",
    "furo>=2024.0",
    "myst-parser>=2.0",
]

README Template

markdown

# Package Name
 
[![PyPI](https://badge.fury.io/py/package.svg)](https://pypi.org/project/package/)
 
Short description of what it does.
 
## Installation
 
uv add package
 
## Quick Start
 
from package import function
result = function(args)
 
## Documentation
 
Full docs at [package.readthedocs.io](https://package.readthedocs.io/)

ReadTheDocs (.readthedocs.yaml)

yaml

version: 2
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"
sphinx:
  configuration: docs/conf.py
python:
  install:
    - method: pip
      path: .
      extra_requirements: [docs]

For detailed setup, see:

[SPHINX_CONFIG.md](SPHINX_CONFIG.md) - Full Sphinx configuration
[TUTORIALS.md](TUTORIALS.md) - Tutorial writing guide

Checklist

README:
- [ ] Clear project description
- [ ] Installation instructions
- [ ] Quick start example
- [ ] Link to full documentation
 
API Docs:
- [ ] All public functions documented
- [ ] Args, Returns, Raises sections
- [ ] Examples in docstrings
- [ ] Type hints included

Learn More

This skill is based on the Documentation section of the Guide to Developing High-Quality Python Libraries by Will McGinnis. See these posts for deeper coverage:

← v1.0.1 All versions