sphinx-shibuya

Restructure Sphinx documentation for the Shibuya theme with compatible extensions.

15|4|Updated Jan 20, 2026
One-click install
npx skills add https://github.com/cofin/flow --skill sphinx-shibuya
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sphinx-shibuya
Source: https://github.com/cofin/flow/tree/main/skills/sphinx-shibuya
Command: npx skills add https://github.com/cofin/flow --skill sphinx-shibuya

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about sphinx-shibuya

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

FAQPage Schema
How do I structure Sphinx documentation using the Shibuya theme?

To build Sphinx documentation with the Shibuya theme, split long documents into short, focused pages and use toctree management with grid card directives to create clear navigation hubs.

What extensions are compatible with the Shibuya theme for Sphinx?

Compatible Sphinx extensions for the Shibuya theme include sphinx_design, sphinx_iconify, sphinx_docsearch, sphinx_tabs, and sphinx_togglebutton, which integrate interactive features and modern design elements into your site.

How do I manage code snippets in Sphinx documentation?

Manage code snippets in Sphinx documentation by using the literalinclude directive with markers to display clean, runnable code examples extracted directly from your source files.

How do I split a large Sphinx documentation file into multiple pages?

Split a large Sphinx documentation file into shorter, focused pages and organize them using toctree management and grid cards navigation to maintain a clean site structure.

Can I use sphinx_design grid cards for navigation in Sphinx docs?

Yes, you can use sphinx_design grid cards for navigation in Sphinx docs to build navigation hubs that replace long documents with structured, modern documentation pages.

Why validate the Sphinx documentation build after restructuring?

Validate the Sphinx documentation build after restructuring to ensure toctree management, Shibuya theme integration, and extension directives function correctly without missing content.