Move star call to dismissable banner

mhostetter · May 9, 2023 · 329aaa6 · 329aaa6
1 parent 5bbec50
commit 329aaa6
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 6 deletions.
diff --git a/docs/_static/extra.css b/docs/_static/extra.css
@@ -44,6 +44,13 @@
  color: var(--md-accent-fg-color);
 }
 
+/* Override announcement banner colors */
+.md-banner {
+ background: #FFE903;
+ color: rgba(0,0,0,.87);
+ --md-default-fg-color: rgba(0,0,0,.87);
+}
+
 /* Override version outdated banner colors */
 [data-md-color-scheme="slate"] .md-banner--warning {
  background: var(--md-footer-bg-color);

diff --git a/docs/_templates/base.html b/docs/_templates/base.html
@@ -1,5 +1,14 @@
 {% extends "!base.html" %}
 
+{% block announce %}
+<p>
+ Enjoying the library? Give us a
+ <span class="md-icon si-icon-inline octicons_star-16"></span>
+ on
+ <a class="reference external" href="https://github.com/mhostetter/galois">GitHub</a>.
+</p>
+{% endblock %}
+
 {% block outdated %}
 You're not viewing the latest version.
 <a href="{{ '../' ~ base_url}}">

diff --git a/docs/conf.py b/docs/conf.py
@@ -152,6 +152,7 @@
  "toc.follow",
  "toc.sticky",
  "content.tabs.link",
+ "announce.dismiss",
  ],
  "palette": [
  {
@@ -275,7 +276,7 @@
  },
  {
  "name": "star",
- "icon": "octicons/star-fill-24",
+ "icon": "octicons/star-16",
  "color": (255, 233, 3), # Gold
  },
  {

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,11 +3,6 @@
 
 The :obj:`galois` library is a Python 3 package that extends NumPy arrays to operate over finite fields.
 
-.. star:: Enjoying the library? Give us a :si-icon:`octicons/star-fill-24` on `GitHub <https://github.com/mhostetter/galois>`_!
- :collapsible:
-
- Help others find this library too!
-
 The user creates a :obj:`~galois.FieldArray` subclass using `GF = galois.GF(p**m)`. `GF` is a subclass of :obj:`numpy.ndarray`
 and its constructor `x = GF(array_like)` mimics the signature of :func:`numpy.array`. The :obj:`~galois.FieldArray` `x` is operated
 on like any other NumPy array except all arithmetic is performed in :math:`\mathrm{GF}(p^m)`, not :math:`\mathbb{R}`.