For AI agents

epythet ships artifacts for coding agents alongside its code. This page lists them, says where each lives in the repository, and points at the machine-readable copies of this documentation.

Skills

Skills are folders holding a SKILL.md (the Agent Skills format): a description that tells an agent when to use it and a body with the procedure. Install one into your agent with gh skill (any host: --agent claude-code, copilot, cursor, codex, gemini), or use the copy bundled in the wheel.

epythet-agentic-readme

Make sure a repository’s README documents its agentic aspects: the skills, subagents and instruction files it ships (<pkg>/data/skills, .claude/skills, .claude/agents, CLAUDE.md, AGENTS.md) and the agent-readable docs its site publishes (llms.txt, <package>.md). Runs epythet ai-readme-check, reads the user’s policy (~/.config/epythet/config.toml: warn or add, humour, agents first) and either reports what is missing or adds and updates a marked “For AI agents” section rendered from user-overridable snippets (epythet snippets). Use when asked “does the README mention the skills”, “add the agent section to the README”, “document the agentic aspects”, when finishing a docs sweep, or before releasing a package that ships skills.

gh skill install i2mint/epythet epythet-agentic-readme --agent claude-code

Source: epythet/data/skills/epythet-agentic-readme (bundled with the pip package).

epythet-ai-artifacts

Find, install and document a repository’s AI agent artifacts: skills (SKILL.md folders under <pkg>/data/skills, skills/, .claude/skills), subagents (.claude/agents, <pkg>/data/agents), instruction files (CLAUDE.md, AGENTS.md, .cursor/rules, .codex), and the machine-readable documentation a site publishes (llms.txt, <package>.md, .md page twins, objects.inv). Use when arriving in an unfamiliar repo and asking “does this project ship skills or agents”, “how do I install this package’s skill”, “where is the agent-readable version of these docs”, or when adding artifacts to a package so that epythet documents them.

gh skill install i2mint/epythet epythet-ai-artifacts --agent claude-code

Source: epythet/data/skills/epythet-ai-artifacts (bundled with the pip package).

epythet-docstring-style

Write and improve Python docstrings that render correctly in epythet/Sphinx and that help both humans and AI agents: the epythet docstring dialect (Google sections, doctests, types in annotations), the quality rubric, the behaviour-claim policy (never document behaviour you have not verified), and the anti-patterns to avoid. Use when writing or editing docstrings, when asked to “document this function/module/package”, “improve the docstrings”, “add examples”, “fix the docstring style”, or when reviewing a docstring sweep. Also use before answering “should the type go in the docstring”.

gh skill install i2mint/epythet epythet-docstring-style --agent claude-code

Source: epythet/data/skills/epythet-docstring-style (bundled with the pip package).

epythet-pages

Diagnose and fix GitHub Pages publishing for Python documentation built with epythet (or any Sphinx site pushed to a gh-pages branch). Use when docs give a 404, the site does not update, Pages is not enabled, the gh-pages branch is missing, the docs CI fails, or when enabling Pages for one repo or every repo in an organisation. Covers epythet check-pages, epythet configure-pages, the Python API, the raw gh api equivalent, and batch operations.

gh skill install i2mint/epythet epythet-pages --agent claude-code

Source: epythet/data/skills/epythet-pages (bundled with the pip package).

epythet-repair-migrate

The per-repository documentation sweep for packages documented with epythet: baseline, validate, repair rendering artifacts in source, improve coverage, correctness and completeness of docstrings, choose a theme, remove a committed docsrc/, and land the change. Use when asked to “migrate the docs to epythet 0.2”, “fix the docstrings across this repo”, “run the docs sweep”, “repair the rendering artifacts”, “upgrade docsrc”, or “clean up this package’s documentation”. Marks which commands exist today and which are coming in a later epythet release.

gh skill install i2mint/epythet epythet-repair-migrate --agent claude-code

Source: epythet/data/skills/epythet-repair-migrate (bundled with the pip package).

epythet-setup

Set up documentation for a Python package with epythet: run the quickstart, read what it produces, configure [tool.epythet] in pyproject.toml, add the GitHub Pages publishing workflow, and upgrade a 0.1.x docsrc. Use when asked to “add docs”, “generate documentation”, “set up Sphinx”, “publish docs to GitHub Pages”, “configure epythet”, “what does [tool.epythet] accept”, or when a project has docstrings but no documentation site. Convention over configuration: nothing needs to be added to the package.

gh skill install i2mint/epythet epythet-setup --agent claude-code

Source: epythet/data/skills/epythet-setup (bundled with the pip package).

epythet-theme

Choose and parametrize the Sphinx theme of an epythet documentation site: the curated pool (furo, shibuya, pydata-sphinx-theme, sphinxawesome-theme, sphinx-book-theme, alabaster, sphinx_rtd_theme), rules of thumb for picking one, the theme / accent / mode / theme_options keys, the derived OKLCH accent colour, and where to browse themes. Use when asked to change, choose or improve a docs theme, set a brand colour, force light or dark mode, why the docs look dated, or “make the docs look like X”.

gh skill install i2mint/epythet epythet-theme --agent claude-code

Source: epythet/data/skills/epythet-theme (bundled with the pip package).

epythet-validate

Check a Python package’s docstrings for rendering artifacts and build problems with epythet validate: the validation levels (lint, parse, build, render, review), the exit codes, output formats, the artifact ledger of rules (DR001…), how findings are recorded, and how to propose a new rule. Use when asked to “validate the docs”, “check docstrings before publishing”, “why does this docstring render wrong”, “gate docs in CI”, “what does DR003 mean”, or when reading or extending epythet’s ledger of documentation problems.

gh skill install i2mint/epythet epythet-validate --agent claude-code

Source: epythet/data/skills/epythet-validate (bundled with the pip package).

The bundled skills are also on disk after pip install epythet, under the package’s data/skills/ directory; link them into an agent without network access with skill link-skills <that directory>.

Subagents

Subagents are Markdown files with a frontmatter (name, description, tools) and a system prompt as the body. Copy one into your project’s .claude/agents/ (or your agent host’s equivalent) to delegate the task it describes.

docs-migrator

Runs the epythet documentation sweep on one repository end to end, baseline, validate, repair rendering artifacts, improve coverage, correctness and completeness of docstrings under the behaviour-claim policy, choose the theme, remove a committed docsrc/, and open a pull request with a before/after report. Use when asked to “sweep the docs of this repo”, “migrate this package to epythet 0.2”, “fix and improve the docstrings across this package”, or to run one repository of a fleet documentation migration.

Source: epythet/data/agents/docs-migrator.md; tools: Bash, Read, Edit, Write, Grep, Glob.

docs-reviewer

Reviews the rendered documentation of a Python package (Level 3 of epythet validate) and returns a review packet of findings that each name a ledger rule or propose a new one, as strict JSON plus draft rule files. Use after a docs build or a docstring sweep when asked to “review the rendered docs”, “look at the built pages for problems”, “find rendering artifacts validate missed”, or “propose ledger rules”. Advisory only, it never gates.

Source: epythet/data/agents/docs-reviewer.md; tools: Bash, Read, Grep, Glob, Write.

Instruction files

Files agents read before working in this repository.

Machine-readable documentation

This site publishes the same documentation in forms that fit an agent’s context window:

  • llms.txt: an index of every page with a one-line description (llms.txt format)

  • epythet.md: the whole documentation as one Markdown file

  • <page>.html.md: a rendered Markdown twin of every page, advertised from each page’s <head> with <link rel="alternate" type="text/markdown">

  • objects.inv: the Sphinx inventory: a symbol-to-URL index (sphobjinv convert plain objects.inv -)