docs: add documentation for announcement

lepture · Dec 30, 2023 · f2a0274 · f2a0274
1 parent 3588f48
commit f2a0274
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 2 deletions.
diff --git a/docs/_static/screenshots/dark-homepage.jpg b/docs/_static/screenshots/dark-homepage.jpg
diff --git a/docs/_static/screenshots/light-homepage.jpg b/docs/_static/screenshots/light-homepage.jpg
diff --git a/docs/customisation/announcement.rst b/docs/customisation/announcement.rst
@@ -0,0 +1,36 @@
+:description: A theme option enables the display of an announcement banner.
+
+Announcement
+============
+
+.. rst-class:: lead
+
+    Display an announcement banner at the top of the page.
+
+----
+
+When there's something to announce, you can include the announcement
+content in the ``conf.py`` announcement option.
+
+.. code-block:: python
+    :caption: conf.py
+
+    html_theme_options = {
+      "announcement": "The content of the announcement",
+    }
+
+.. note::
+
+    HTML is allowed in the ``announcement`` option.
+
+Here shows an example with ``announcement`` configuration.
+
+.. container:: image-container
+
+    .. image:: /_static/screenshots/light-homepage.jpg
+      :class: light-only
+      :align: center
+
+    .. image:: /_static/screenshots/dark-homepage.jpg
+      :class: dark-only
+      :align: center
diff --git a/docs/customisation/index.rst b/docs/customisation/index.rst
@@ -85,6 +85,7 @@ footer, navbar, and sidebar.
     logos
     colors
     navbar
+    announcement
     social
     fonts
     sidebar

diff --git a/docs/extensions/sphinx-tabs.rst b/docs/extensions/sphinx-tabs.rst
@@ -98,9 +98,9 @@ How it looks like
 -----------------
 
 .. image:: /_static/screenshots/light-sphinx-tabs.png
-   :class: dark-hidden
+   :class: light-only
    :align: center
 
 .. image:: /_static/screenshots/dark-sphinx-tabs.png
-   :class: light-hidden
+   :class: dark-only
    :align: center