Maintain Sphinx documentation with API references, guides, and changelog updates.
npx skills add https://github.com/christophevg/c3 --skill documentation-christophevg
Please help me install this Agent Skill. Skill: documentation Source: https://github.com/christophevg/c3/tree/main/skills/documentation Command: npx skills add https://github.com/christophevg/c3 --skill documentation-christophevg
Updating and publishing high-quality project documentation can stall development, especially when Sphinx configuration, API reference pages, and changelogs drift out of sync.
Use the documentation skill to update your Sphinx documentation for a readthedocs.org deployment.
High-intent search queries and answers about installing and using this skill.
To generate API documentation and update changelogs for a Sphinx project, you can scaffold initial configurations, update module-level API reference pages, and add structured changelog entries. The process validates your docs structure and runs a build to ensure no broken links or warnings before publishing.
Scaffolding initial Sphinx documentation for readthedocs involves creating standard assets like conf.py, Makefile, and index files. When key docs assets are missing, the documentation setup process creates the standard structure automatically and validates the configuration to prepare for readthedocs deployment.
Keeping Sphinx API reference pages synchronized after adding features requires updating module-level pages in the docs/api directory. The documentation maintenance process wires updated API references into the existing documentation navigation and validates the changes through a successful documentation build.
Yes, the documentation build process works with uv-based sphinx-build environments. It runs the documentation build using the project's make targets or uv-based sphinx-build commands, checking for warnings, errors, and broken links to ensure the build is successful before publishing.
Adding structured changelog entries during a release cycle involves editing the docs/development/changelog.md file. The documentation synchronization process also refreshes guides like quickstart and installation to reflect feature changes, ensuring release documentation hygiene is maintained across the project.
Sphinx documentation builds may fail with broken links if the docs structure is invalid or API references are not properly wired into navigation. Running a build verification checks for warnings, errors, and broken links, ensuring the documentation structure is validated before attempting readthedocs publishing.
xiaolaiParse Sphinx conf.py and toctree to generate documentation templates.
CHENyiru3Generate Google-style docstrings, Sphinx configuration, and ReadTheDocs-ready documentation templates.
rodmena-limitedGenerate documentation from source code and API annotations using Sphinx, MkDocs, TypeDoc, and Nextra.
brainbrewlabsPublishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.
