jkitchin

Build Docs — Documentation skill for Claude Code

Documentation community

Build and preview the Jupyter Book documentation.

How to install Build Docs

Installs to ~/.claude/commands/jkitchin-vasp-build-docs.md

Terminal
mkdir -p ~/.claude/commands && curl -fsSL https://raw.githubusercontent.com/jkitchin/vasp/HEAD/.claude/commands/build-docs.md -o ~/.claude/commands/jkitchin-vasp-build-docs.md

Restart Claude Code, or start a new session, for it to be picked up.

What Build Docs does

Build and preview the Jupyter Book documentation.

Execute the documentation build process:

  1. Check if jupyter-book is installed:

    pip show jupyter-book
  2. If not installed, install documentation dependencies:

    pip install -r docs/requirements.txt
  3. Build the documentation:

    jupyter-book build docs
  4. Report build status and any warnings/errors

  5. Show how to view the built documentation:

    • Local path: docs/_build/html/index.h

Alternatives in Documentation

  • Doc Co-authoring — Guide users through structured workflow for co-authoring documentation 94.1k ★
  • OpenAI Docs — Provide authoritative guidance from OpenAI developer documentation 14.6k ★
  • Translate Doc Zh — Translate English documentation to Chinese 5.7k ★

Full documentation available on GitHub

View Source Repository