feat: add example for sphinx-click

docs/changelog.rst

@@ -16,7 +16,7 @@ Shibuya uses date based release segments. For pre-releases, it follows :pep:`440
 2024.4.27
 ---------
 
-- **New**: Added integration with :ref:`sqlalchemy`.
+- **New**: Added integration with :ref:`sphinx-sqlalchemy`.
 - **Fix**: Improve accessibility with ``aria-label``.
 - **Fix**: Improve style for nav links and docsearch.
 - **Breaking**: Fix typo of ``Lucide`` icons.

docs/conf.py

@@ -28,6 +28,7 @@
     "numpydoc",
     "sphinx_sitemap",
     "sphinxcontrib.mermaid",
+    "sphinx_click",
     "sphinx_sqlalchemy",
 ]
 todo_include_todos = True

docs/contributing/roadmap.rst

@@ -40,7 +40,8 @@ Make sure it works well with other extensions. Currently integrated with:
 - :bdg-success:`DONE` :ref:`numpydoc`
 - :bdg-success:`DONE` ``sphinx-gallery``
 - :bdg-success:`DONE` :ref:`sphinxcontrib-mermaid`
-- :bdg-success:`DONE` :ref:`sqlalchemy`
+- :bdg-success:`DONE` :ref:`sphinx-sqlalchemy`
+- :bdg-success:`DONE` :ref:`sphinx-click`
 
 Instant search
 --------------

docs/example_code/click_demo.py

@@ -0,0 +1,17 @@
+import click
+
+@click.group()
+def greet():
+    """A sample command group."""
+    pass
+
+@greet.command()
+@click.argument('user', envvar='USER')
+def hello(user):
+    """Greet a user."""
+    click.echo('Hello %s' % user)
+
+@greet.command()
+def world():
+    """Greet the world."""
+    click.echo('Hello world!')

docs/extensions/sphinx-click.rst

@@ -0,0 +1,40 @@
+.. _sphinx-click:
+
+sphinx-click
+=================
+
+sphinx-click is a Sphinx plugin that allows you to automatically extract documentation
+from a click-based application and include it in your docs.
+
+- **Documentation**: https://sphinx-click.readthedocs.io/
+- **Source Code**: https://github.com/click-contrib/sphinx-click
+
+Usage
+-----
+
+Install ``sphinx-click``:
+
+.. code-block:: bash
+
+    pip install sphinx-click
+
+Add ``sphinx_click`` to your ``conf.py``:
+
+.. code-block:: python
+
+    extensions = [
+        'sphinx_click',
+    ]
+
+Example
+-------
+
+.. code-block:: none
+
+    .. click:: click_demo:greet
+        :prog: greet
+        :nested: full
+
+.. click:: click_demo:greet
+   :prog: greet
+   :nested: full

docs/extensions/sphinx-sqlalchemy.rst

@@ -1,4 +1,4 @@
-.. _sqlalchemy:
+.. _sphinx-sqlalchemy:
 
 sphinx-sqlalchemy
 =================

docs/index.rst

@@ -76,6 +76,7 @@ Shibuya
     extensions/numpydoc
     extensions/mermaid
     extensions/docsearch
+    extensions/sphinx-click
     extensions/sphinx-sqlalchemy
 
 .. toctree::

requirements.txt

@@ -8,6 +8,7 @@ jupyter-sphinx
 sphinx-togglebutton
 sphinxcontrib-mermaid
 sphinx-docsearch
+sphinx-click
 nbsphinx
 myst-parser
 numpy