sphinx-shibuya

What problem does it solve?

This Skill streamlines the creation and restructuring of Sphinx documentation, specifically when utilizing the Shibuya theme and its associated extensions, ensuring a clean, navigable, and modern documentation site.

Core Features & Use Cases

• Structure Optimization: Guides users to split long documents, create navigation hubs with grid cards, and maintain focused content.
• Extension Integration: Recommends and details the use of Shibuya-compatible extensions like sphinx_design, sphinx_iconify, sphinx_docsearch, sphinx_tabs, and sphinx_togglebutton.
• Code Snippet Management: Promotes the use of literalinclude with markers for clean, runnable code examples.
• Use Case: Reimagining a project's documentation from a single large file into a well-structured site with clear navigation, using Shibuya's modern design elements and interactive features.

Quick Start

Use the sphinx-shibuya skill to restructure the documentation in the 'docs/' directory, focusing on short pages and Shibuya theme compatibility.