Build and preview Sphinx documentation locally with MyST parser.
npx skills add https://github.com/OliverSieweke/occhio --skill documentation-oliversieweke
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/OliverSieweke/occhio/tree/main/skills/documentation Command: npx skills add https://github.com/OliverSieweke/occhio --skill documentation-oliversieweke
Sphinx documentation projects often require repetitive setup, configuration, and local validation. This Skill provides a concise, guided approach to building and previewing docs locally, reducing setup friction and ensuring consistency across environments.
Install the documentation dependencies and start a local live preview of the Sphinx docs.
High-intent search queries and answers about installing and using this skill.
To build and preview Sphinx documentation locally, you can automate the process by installing project dependencies and running the live HTML preview server using the provided Make targets like make livehtml.
Yes, this approach explicitly supports Sphinx projects using the MyST parser for Markdown, enabling local HTML preview and configuration management for Markdown-based documentation.
The best way to manage Sphinx configuration is by automating dependency installation and handling common configuration aspects like conf.py, extensions, and themes for consistent local validation.
Yes, you can start a live HTML preview server to iteratively edit and validate Sphinx docs locally, automatically reflecting changes as you modify your Markdown or reStructuredText files.
Automating local Sphinx docs builds reduces repetitive setup friction and ensures consistency across environments by handling dependency installation, configuration, and the make html process.
Yes, a conf.py file is required to define your project's extensions and themes, which the automation process reads to manage configuration and output to the docs build directory.
pjy4617Automate Sphinx documentation builds into HTML, PDF, and EPUB formats.
brainbrewlabsPublishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.
miko06Update project documentation files after shipping using Git and Bash.
windyskyGenerate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.
