docs: update documentation

lepture · Apr 8, 2024 · f5e05b8 · f5e05b8
1 parent f34bd8b
commit f5e05b8
Show file tree

Hide file tree

Showing 11 changed files with 64 additions and 13 deletions.
diff --git a/docs/contributing/roadmap.rst b/docs/contributing/roadmap.rst
@@ -45,4 +45,7 @@ Instant search
 --------------
 
 When searching in the search input, show a popup with instant results.
-This could be done by calling the search script manually.
+This could be done by the bellow extensions:
+
+- :bdg-success:`DONE` :ref:`docsearch`
+- :bdg-warning:`TODO` readthedocs-sphinx-search
diff --git a/docs/customisation/icons.rst b/docs/customisation/icons.rst
@@ -4,13 +4,41 @@ Icons
 Lucid Icons
 -----------
 
-The Shibuya theme uses a subset of `Lucid <https://lucide.dev/>`_ icons.
-The icons are used for navigations, admonitions, and etc.
+Shibuya theme uses a subset of `Lucid <https://lucide.dev/>`_ icons.
+The icons are used for navigations, admonitions, and etc:
+
+.. code-block:: none
+
+    --i-alert-url
+    --i-arrows-url
+    --i-award-url
+    --i-bell-url
+    --i-bookmark-url
+    --i-calendar-url
+    --i-check-url
+    --i-chevron-url
+    --i-close-url
+    --i-external-link-url
+    --i-flame-url
+    --i-git-fork-url
+    --i-help-url
+    --i-languages-url
+    --i-laptop-url
+    --i-link-url
+    --i-menu-url
+    --i-milestone-url
+    --i-moon-url
+    --i-outdent-url
+    --i-rocket-url
+    --i-skull-url
+    --i-star-url
+    --i-sun-url
+    --i-zap-url
 
 Simple Icons
 ------------
 
-The Shibuya theme uses a subset of `Simple Icons <https://simpleicons.org/>`_
+Shibuya theme uses a subset of `Simple Icons <https://simpleicons.org/>`_
 for social networks. These icons include:
 
 - GitHub: ``--i-github-url``
@@ -20,6 +48,17 @@ for social networks. These icons include:
 - Mastodon: ``--i-mastodon-url``
 - YouTube: ``--i-youtube-url``
 - X (Twitter): ``--i-x-twitter-url``
+- Reddit: ``--i-reddit-url``
 
 Custom Icons
 ------------
+
+You can customize the icons by defining CSS variables for each icon,
+for example:
+
+.. code-block:: css
+    :caption: custom.css
+
+    :root {
+      --i-star-url:url("data:image/svg+xml;utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='m12 2 3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z'/%3E%3C/svg%3E");
+    }
diff --git a/docs/extensions/docsearch.rst b/docs/extensions/docsearch.rst
@@ -7,7 +7,8 @@ sphinx-docsearch
 
 ``sphinx-docsearch`` replaces Sphinx's built-in search with Algolia DocSearch.
 
-**Documentation**: https://sphinx-docsearch.readthedocs.io/
+- **Documentation**: https://sphinx-docsearch.readthedocs.io/
+- **Source Code**: https://github.com/algolia/sphinx-docsearch
 
 Install
 -------

diff --git a/docs/extensions/jupyter-sphinx.rst b/docs/extensions/jupyter-sphinx.rst
@@ -8,7 +8,8 @@ jupyter-sphinx
 Jupyter-sphinx is a Sphinx extension that executes embedded code
 in a Jupyter kernel, and embeds outputs of that code in the document.
 
-**Documentation**: https://jupyter-sphinx.readthedocs.io/
+- **Documentation**: https://jupyter-sphinx.readthedocs.io/
+- **Source Code**: https://github.com/jupyter/jupyter-sphinx
 
 Install
 -------

diff --git a/docs/extensions/mermaid.rst b/docs/extensions/mermaid.rst
@@ -8,7 +8,8 @@ sphinxcontrib-mermaid
 This extension allows you to embed Mermaid graphs in your documents,
 including general flowcharts, sequence diagrams, gantt diagrams and more.
 
-**Documentation**: https://sphinxcontrib-mermaid-demo.readthedocs.io/
+- **Documentation**: https://sphinxcontrib-mermaid-demo.readthedocs.io/
+- **Source Code**: https://github.com/mgaitan/sphinxcontrib-mermaid
 
 Install
 -------

diff --git a/docs/extensions/nbsphinx.ipynb b/docs/extensions/nbsphinx.ipynb
@@ -12,7 +12,8 @@
         "\n",
         "``nbsphinx`` is a Sphinx extension that provides a source parser for ``*.ipynb`` files.\n",
         "\n",
-        "**Documentation**: https://nbsphinx.readthedocs.io/\n"
+        "- **Documentation**: https://nbsphinx.readthedocs.io/\n",
+        "- **Source Code**: https://github.com/spatialaudio/nbsphinx\n"
       ]
     },
     {

diff --git a/docs/extensions/numpydoc.rst b/docs/extensions/numpydoc.rst
@@ -7,7 +7,8 @@ numpydoc
 
 Numpy's Sphinx extensions to power Numpy's docstring syntax.
 
-**Documentation**: https://numpydoc.readthedocs.io/
+- **Documentation**: https://numpydoc.readthedocs.io/
+- **Source Code**: https://github.com/numpy/numpydoc
 
 Install
 -------

diff --git a/docs/extensions/sphinx-copybutton.rst b/docs/extensions/sphinx-copybutton.rst
@@ -8,7 +8,8 @@ sphinx-copybutton
 Add a little “copy” button to the right of your code blocks. This extension
 is maintained by Executable Books.
 
-**Documentation**: https://sphinx-copybutton.readthedocs.io/
+- **Documentation**: https://sphinx-copybutton.readthedocs.io/
+- **Source Code**: https://github.com/executablebooks/sphinx-copybutton
 
 Install
 -------

diff --git a/docs/extensions/sphinx-design.rst b/docs/extensions/sphinx-design.rst
@@ -7,7 +7,8 @@ sphinx-design
 
 ``sphinx-design`` extension add many components for Sphinx documentation.
 
-**Documentation**: https://sphinx-design.readthedocs.io/
+- **Documentation**: https://sphinx-design.readthedocs.io/
+- **Source Code**: https://github.com/executablebooks/sphinx-design
 
 Install
 -------

diff --git a/docs/extensions/sphinx-tabs.rst b/docs/extensions/sphinx-tabs.rst
@@ -8,7 +8,8 @@ sphinx-tabs
 sphinx-tab is an extension maintained by Executable Books.
 This extension can create tabbed content.
 
-**Documentation**: https://sphinx-tabs.readthedocs.io/
+- **Documentation**: https://sphinx-tabs.readthedocs.io/
+- **Source Code**: https://github.com/executablebooks/sphinx-tabs
 
 Install
 -------

diff --git a/docs/extensions/sphinx-togglebutton.rst b/docs/extensions/sphinx-togglebutton.rst
@@ -5,7 +5,8 @@ sphinx-togglebutton
 
 A small sphinx extension to add “toggle button” elements to sections of your page.
 
-**Documentation**: https://sphinx-togglebutton.readthedocs.io/
+- **Documentation**: https://sphinx-togglebutton.readthedocs.io/
+- **Source Code**: https://github.com/executablebooks/sphinx-togglebutton
 
 Install
 -------