manage_docs

Automate Sphinx builds, synchronization, and validation for bilingual English and Japanese documentation.

1|Updated Dec 17, 2025
One-click install
npx skills add https://github.com/tatsuki-washimi/gwexpy --skill manage-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: manage_docs
Source: https://github.com/tatsuki-washimi/gwexpy/tree/main/.agent/skills/manage_docs
Command: npx skills add https://github.com/tatsuki-washimi/gwexpy --skill manage-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

ドキュメントのビルド、同期、検証を一括管理し、作業のムダを減らし英語・日本語ドキュメントの出力を一貫性のある状態に保ちます。

Core Features & Use Cases

  • Sphinx を用いた英語・日本語ドキュメントのビルドと同期を自動化します。
  • 出力の検証とリンクチェックを含むビルドの整合性を保証します。
  • Use Case: CI/CD の一部として英日ドキュメントの自動ビルドと検証を行い、公開前の品質を確保します。

Quick Start

英語と日本語のドキュメントを Sphinx でビルドして HTML 出力を生成してください。

Frequently Asked Questions about manage_docs

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

FAQPage Schema
How do I automate Sphinx documentation builds for English and Japanese projects?

Automate Sphinx documentation builds by running make or sphinx-build to render HTML from docs/web/en and docs/web/ja directories. This ensures consistent bilingual output and reduces manual effort.

How does cross-link verification work for bilingual Sphinx docs?

Cross-link verification checks bilingual Sphinx documentation builds for broken or inconsistent links between English and Japanese outputs. This validation runs automatically as part of the build workflow to ensure quality.

Do I need Sphinx installed to build and verify documentation locally?

Yes, you need Sphinx and common build tooling like make or sphinx-build installed locally. These tools render the HTML output from your source files and enable incremental builds and verification checks.

Can I integrate documentation verification into a CI/CD pipeline?

Yes, you can integrate documentation verification into CI/CD pipelines to automatically build and validate English and Japanese Sphinx docs. This ensures output quality and consistency before publishing.

What is the best way to keep English and Japanese documentation synchronized?

Keep English and Japanese documentation synchronized by automating the build and validation process for both language directories together. This enforces consistency and catches discrepancies during the build.

Why are my Sphinx incremental builds not reflecting documentation updates?

Sphinx incremental builds may fail to reflect updates if source files are not properly saved or if build caching issues occur. Running a clean build with sphinx-build ensures the latest HTML output is generated correctly.