sphinx-docs-sync

Audit Sphinx documentation across sibling repositories for configuration and asset alignment.

120|10|Updated Oct 18, 2021
One-click install
npx skills add https://github.com/kdeldycke/click-extra --skill sphinx-docs-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sphinx-docs-sync
Source: https://github.com/kdeldycke/click-extra/tree/main/.claude/skills/sphinx-docs-sync
Command: npx skills add https://github.com/kdeldycke/click-extra --skill sphinx-docs-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Two-way comparison and synchronization of Sphinx documentation across sibling projects. Discovers discrepancies in conf.py, install.md, index.md toctree, pyproject.toml docs dependencies, extra-deps sections, readme badges, and static assets. Use when you want to align documentation structure, catch stale dependencies, or push improvements across your Sphinx-enabled repositories.

Core Features & Use Cases

  • Two-way auditing of docs/conf.py across siblings
  • Detects differences in install.md, index.md toctree, pyproject.toml docs dependencies, and extra-deps sections
  • Suggests concrete alignment actions to push improvements across projects

Quick Start

Run a two-way comparison to identify and align discrepancies in sibling projects’ Sphinx configuration and documentation assets

Frequently Asked Questions about sphinx-docs-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I synchronize Sphinx documentation across multiple sibling repositories?

Sphinx documentation synchronization across sibling repositories audits conf.py, install.md, and index.md toctree to detect discrepancies. It generates actionable alignment recommendations and validates cross-project assets before pushing changes to ensure consistency.

What is the best way to align conf.py settings across related Sphinx projects?

Aligning conf.py settings across related Sphinx projects requires a two-way comparison of configurations and dependencies. This approach detects differences in pyproject.toml docs dependencies and extra-deps sections, suggesting concrete actions to push improvements across all projects.

How does cross-repo Sphinx documentation auditing work for install.md and index.md files?

Cross-repo Sphinx documentation auditing performs a two-way comparison of install.md files and index.md toctree structures across sibling projects. It identifies structural differences and stale dependencies, then validates assets and references to ensure documentation consistency before any push occurs.

Can I detect stale documentation dependencies across multiple Sphinx-enabled repositories?

Detecting stale documentation dependencies across multiple Sphinx-enabled repositories is possible by comparing pyproject.toml docs dependencies and extra-deps sections. The audit identifies discrepancies in these files and recommends concrete alignment actions to update all sibling projects consistently.

When should I run a Sphinx documentation consistency check across sibling projects?

Running a Sphinx documentation consistency check across sibling projects is necessary when you want to align documentation structure, catch stale dependencies, or push improvements across repositories. It validates static assets and references before push to prevent cross-project configuration drift.