docs: consolidate extensions into their own section

Author: aksiome

docs/conf.py

@@ -47,6 +47,7 @@
     "colon_fence",
     "deflist",
     "fieldlist",
+    "linkify",
     "substitution",
 ]
 myst_heading_anchors = 3

docs/extensions/click-extra.md

@@ -0,0 +1,5 @@
+# click-extra
+
+```{todo}
+Support this extension.
+```

docs/extensions/index.md

@@ -0,0 +1,12 @@
+---
+hide-sidebar-secondary: true
+---
+
+# 🧩 Extensions
+
+```{toctree}
+:titlesonly:
+:glob:
+
+*
+```

docs/extensions/jupyter-sphinx.md

@@ -0,0 +1,5 @@
+# jupyter-sphinx
+
+```{todo}
+Support this extension.
+```

docs/extensions/nbsphinx.md

@@ -0,0 +1,5 @@
+# nbsphinx
+
+```{todo}
+Support this extension.
+```

docs/kitchen-sink/extensions/numpydoc.md docs/extensions/numpydoc.mddocs/kitchen-sink/extensions/numpydoc.md renamed to docs/extensions/numpydoc.md

@@ -1,130 +1,11 @@
 # numpydoc
 
-## Example
-
-### Source
-
-```
-"""Docstring for the example.py module.
-
-Modules names should have short, all-lowercase names.  The module name may
-have underscores if this improves readability.
-
-Every module should have a docstring at the very top of the file.  The
-module's docstring may extend over multiple lines.  If your docstring does
-extend over multiple lines, the closing three quotation marks must be on
-a line by itself, preferably preceded by a blank line.
-
-"""
-
-import os  # standard library imports first
-
-# Do NOT import using *, e.g. from numpy import *
-#
-# Import the module using
-#
-#   import numpy
-#
-# instead or import individual functions as needed, e.g
-#
-#  from numpy import array, zeros
-#
-# If you prefer the use of abbreviated module names, we suggest the
-# convention used by NumPy itself::
-
-import numpy as np
-import matplotlib as mpl
-import matplotlib.pyplot as plt
-
-# These abbreviated names are not to be used in docstrings; users must
-# be able to paste and execute docstrings after importing only the
-# numpy module itself, unabbreviated.
-
+Sphinx extension that provides support for the Numpy docstring format in Sphinx.
 
-def foo(var1, var2, *args, long_var_name="hi", only_seldom_used_keyword=0, **kwargs):
-    r"""Summarize the function in one line.
+- **Documentation**: https://numpydoc.readthedocs.io/
+- **Source Code**: https://github.com/numpy/numpydoc
 
-    Several sentences providing an extended description. Refer to
-    variables using back-ticks, e.g. `var`.
-
-    Parameters
-    ----------
-    var1 : array_like
-        Array_like means all those objects -- lists, nested lists, etc. --
-        that can be converted to an array.  We can also refer to
-        variables like `var1`.
-    var2 : int
-        The type above can either refer to an actual Python type
-        (e.g. ``int``), or describe the type of the variable in more
-        detail, e.g. ``(N,) ndarray`` or ``array_like``.
-    *args : iterable
-        Other arguments.
-    long_var_name : {'hi', 'ho'}, optional
-        Choices in brackets, default first when optional.
-
-    Returns
-    -------
-    type
-        Explanation of anonymous return value of type ``type``.
-    describe : type
-        Explanation of return value named `describe`.
-    out : type
-        Explanation of `out`.
-    type_without_description
-
-    Other Parameters
-    ----------------
-    only_seldom_used_keyword : int, optional
-        Infrequently used parameters can be described under this optional
-        section to prevent cluttering the Parameters section.
-    **kwargs : dict
-        Other infrequently used keyword arguments. Note that all keyword
-        arguments appearing after the first parameter specified under the
-        Other Parameters section, should also be described under this
-        section.
-
-    Raises
-    ------
-    BadException
-        Because you shouldn't have done that.
-
-    See Also
-    --------
-    numpy.array : Relationship (optional).
-    numpy.ndarray : Relationship (optional), which could be fairly long, in
-                    which case the line wraps here.
-    numpy.dot, numpy.linalg.norm, numpy.eye
-
-    References
-    ----------
-    Cite the relevant literature, e.g. [1]_.  You may also cite these
-    references in the notes section above.
-
-    .. [1] O. McNoleg, "The integration of GIS, remote sensing,
-       expert systems and adaptive co-kriging for environmental habitat
-       modelling of the Highland Haggis using object-oriented, fuzzy-logic
-       and neural-network techniques," Computers & Geosciences, vol. 22,
-       pp. 585-588, 1996.
-
-    Examples
-    --------
-    These are written in doctest format, and should illustrate how to
-    use the function.
-
-    >>> a = [1, 2, 3]
-    >>> print([x + 3 for x in a])
-    [4, 5, 6]
-    >>> print("a\nb")
-    a
-    b
-    """
-    # After closing class docstring, there should be one blank line to
-    # separate following codes (according to PEP257).
-    # But for function, method and module, there should be no blank lines
-    # after closing the docstring.
-```
-
-### Rendered
+## Example
 
 ```{raw} html
 <p>Docstring for the example.py module.</p>

docs/extensions/sphinx-click.md

@@ -0,0 +1,5 @@
+# sphinx-click
+
+```{todo}
+Support this extension.
+```

…n-sink/extensions/sphinx-contributors.md docs/extensions/sphinx-contributors.mddocs/kitchen-sink/extensions/sphinx-contributors.md renamed to docs/extensions/sphinx-contributors.md docs/kitchen-sink/extensions/sphinx-contributors.md renamed to docs/extensions/sphinx-contributors.md

@@ -1,5 +1,9 @@
 # sphinx-contributors
 
+Sphinx extension that helps you recognize the people who have contributed to an open-source project.
+
+- **Documentation**: https://sphinx-contributors.readthedocs.io/
+- **Source Code**: https://github.com/dgarcia360/sphinx-contributors
 
 ## Example
 

docs/extensions/sphinx-copybutton.md

@@ -0,0 +1,26 @@
+# sphinx-copybutton
+
+Sphinx extension that adds a "copy" button to code blocks in Sphinx.
+
+- **Documentation**: https://sphinx-copybutton.readthedocs.io/
+- **Source Code**: https://github.com/executablebooks/sphinx-copybutton
+
+## Example
+
+```{hint}
+Hover on the code block, to see the copy button.
+```
+
+```py
+from typing import Iterator
+
+# This is an example
+class Math:
+    @staticmethod
+    def fib(n: int) -> Iterator[int]:
+        """Fibonacci series up to n"""
+        a, b = 0, 1
+        while a < n:
+            yield a
+            a, b = b, a + b
+```

docs/extensions/sphinx-datatables.md

@@ -0,0 +1,5 @@
+# sphinx-datatables
+
+```{todo}
+Support this extension.
+```