feat: add sphinx-contributors support

Author: aksiome

docs/conf.py

@@ -23,12 +23,21 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     # External stuff
+    "click_extra.sphinx",
+    "jupyter_sphinx",
     "myst_parser",
+    "nbsphinx",
+    "sphinx_click",
+    "sphinx_contributors",
     "sphinx_copybutton",
+    "sphinx_datatables",
     "sphinx_design",
+    "sphinx_sitemap",
     "sphinx_togglebutton",
     "sphinx_treeview",
     "sphinxcontrib.mermaid",
+    "sphinxcontrib.video",
+    "sphinxcontrib.youtube",
 ]
 
 # -- Options for Markdown files ----------------------------------------------
@@ -63,6 +72,7 @@
 html_title = "Breeze"
 html_logo = "_static/logo.png"
 html_favicon = "_static/logo.png"
+html_baseurl = "https://sphinx-breeze-theme.readthedocs.io/"
 
 html_theme_options = {
     "external_links": [

docs/kitchen-sink/extensions/sphinx-contributors.md

@@ -0,0 +1,101 @@
+# sphinx-contributors
+
+
+## Example
+
+::::{tab-set}
+
+:::{tab-item} MyST
+````md
+```{contributors} aksiome/breeze
+```
+````
+:::
+
+:::{tab-item} RST
+````rst
+.. contributors:: aksiome/breeze
+````
+:::
+
+::::
+
+```{contributors} aksiome/breeze
+```
+
+---
+
+::::{tab-set}
+
+:::{tab-item} MyST
+````md
+```{contributors} aksiome/breeze
+:avatars:
+```
+````
+:::
+
+:::{tab-item} RST
+````rst
+.. contributors:: aksiome/breeze
+    :avatars:
+````
+:::
+
+::::
+
+```{contributors} aksiome/breeze
+:avatars:
+```
+
+---
+
+::::{tab-set}
+
+:::{tab-item} MyST
+````md
+```{contributors} aksiome/breeze
+:contributions:
+```
+````
+:::
+
+:::{tab-item} RST
+````rst
+.. contributors:: aksiome/breeze
+    :contributions:
+````
+:::
+
+::::
+
+```{contributors} aksiome/breeze
+:contributions:
+```
+
+---
+
+::::{tab-set}
+:::{tab-item} MyST
+````md
+```{contributors} aksiome/breeze
+:avatars:
+:contributions:
+```
+````
+:::
+
+:::{tab-item} RST
+````rst
+.. contributors:: aksiome/breeze
+    :avatars:
+    :contributions:
+````
+:::
+
+::::
+
+```{contributors} aksiome/breeze
+:avatars:
+:contributions:
+```

src/sphinx_breeze_theme/assets/styles/breeze.css

@@ -60,5 +60,6 @@
 @import "./extensions/mermaid.css";
 @import "./extensions/copybutton.css";
 @import "./extensions/togglebutton.css";
+@import "./extensions/contributors.css";
 @import "./extensions/readthedocs.css";
 @import "./extensions/treeview.css";

src/sphinx_breeze_theme/assets/styles/extensions/contributors.css

@@ -0,0 +1,32 @@
+
+.sphinx-contributors {
+  margin-block: 1.5rem;
+
+  .sphinx-contributors_list__item {
+    padding: 0;
+    margin: 0;
+  }
+
+  .sphinx-contributors_contributor__username,
+  .sphinx-contributors_contributor__contributions {
+    margin: 0;
+  }
+}
+
+.sphinx-contributors--avatars {
+  .sphinx-contributors_list {
+    display: grid;
+    padding: 0;
+    gap: 1rem;
+    justify-content: start;
+    grid-template-columns: repeat(auto-fill, minmax(180px, 1fr));
+  }
+
+  .sphinx-contributors_contributor {
+    align-items: center;
+  }
+
+  .sphinx-contributors_contributor__contributions:before {
+    content: none;
+  }
+}