Distinguish beta from stable support in docs

beeware · Jan 31, 2023 · 6ccf694 · 6ccf694
1 parent cddb9e4
commit 6ccf694
Show file tree

Hide file tree

Showing 38 changed files with 72 additions and 143 deletions.
diff --git a/changes/1762.doc.rst b/changes/1762.doc.rst
@@ -0,0 +1 @@
+API support tables now indicate beta status using a dimmed check mark.
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -1,14 +1,30 @@
-div.body table.widget-descriptions td p
-{
-    text-align: center;
+body {
+    --color-beta: #c8c8c8;
+    --color-beta-dark: #484848;
+}
+body[data-theme="dark"] {
+    --color-beta: var(--color-beta-dark);
 }
-div.body table.widget-support th p,
-div.body table.widget-support td p {
+@media (prefers-color-scheme: dark) {
+    body:not([data-theme="light"]) {
+        --color-beta: var(--color-beta-dark);
+    }
+}
+
+div.widget-descriptions td p,
+div.widget-support td p {
     text-align: center;
 }
 
-div.body table.widget-descriptions td:first-of-type p,
-div.body table.widget-descriptions th:first-of-type p
-{
+div.widget-descriptions th:first-of-type p {
     text-align: left;
 }
+
+span.stable {
+    font-weight: bold;
+}
+
+span.beta {
+    font-weight: bold;
+    color: var(--color-beta);
+}
diff --git a/docs/_static/yes.png b/docs/_static/yes.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -100,6 +100,14 @@
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
 
+# Check marks for API support tables.
+rst_prolog = """
+.. role:: stable
+.. role:: beta
+.. |y| replace:: :stable:`✓`
+.. |b| replace:: :beta:`✓`
+"""
+
 
 # -- Options for HTML output ---------------------------------------------------
 

diff --git a/docs/reference/api/app.rst b/docs/reference/api/app.rst
@@ -8,9 +8,6 @@ Application
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(App|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The app is the main entry point and container for the Toga GUI.
 
 Usage

diff --git a/docs/reference/api/containers/box.rst b/docs/reference/api/containers/box.rst
@@ -8,9 +8,6 @@ Box
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Box|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The box is a generic container for widgets, allowing you to construct layouts.
 
 Usage

diff --git a/docs/reference/api/containers/optioncontainer.rst b/docs/reference/api/containers/optioncontainer.rst
@@ -8,9 +8,6 @@ Option Container
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(OptionContainer|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The Option Container widget is a user-selection control for choosing from a pre-configured list of controls, like a tab view.
 
 .. figure:: /reference/images/OptionContainer.jpeg

diff --git a/docs/reference/api/containers/scrollcontainer.rst b/docs/reference/api/containers/scrollcontainer.rst
@@ -8,9 +8,6 @@ Scroll Container
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(ScrollContainer|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The Scroll Container is similar to the iframe or scrollable div element in HTML, it contains an object with
 its own scrollable selection.
 

diff --git a/docs/reference/api/containers/splitcontainer.rst b/docs/reference/api/containers/splitcontainer.rst
@@ -8,9 +8,6 @@ Split Container
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(SplitContainer|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The split container is a container with a movable split and the option for 2 or 3 elements.
 
 .. figure:: /reference/images/SplitContainer.jpeg

diff --git a/docs/reference/api/index.rst b/docs/reference/api/index.rst
@@ -67,9 +67,6 @@ Resources
  :doc:`Image </reference/api/resources/images>`      An image
 =================================================== =================================
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 .. toctree::
    :hidden:
 

diff --git a/docs/reference/api/mainwindow.rst b/docs/reference/api/mainwindow.rst
@@ -8,9 +8,6 @@ MainWindow
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(MainWindow|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 A window for displaying components to the user
 
 Usage

diff --git a/docs/reference/api/resources/command.rst b/docs/reference/api/resources/command.rst
@@ -8,9 +8,6 @@ Command
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Command|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 
 Usage
 -----

diff --git a/docs/reference/api/resources/fonts.rst b/docs/reference/api/resources/fonts.rst
@@ -8,9 +8,6 @@ Font
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Font|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The font class is used for abstracting the platforms implementation of fonts.
 
 Reference

diff --git a/docs/reference/api/resources/group.rst b/docs/reference/api/resources/group.rst
@@ -8,9 +8,6 @@ Group
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Group|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 
 
 Usage

diff --git a/docs/reference/api/resources/icons.rst b/docs/reference/api/resources/icons.rst
@@ -8,9 +8,6 @@ Icon
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Icon|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 
 Usage
 -----

diff --git a/docs/reference/api/resources/images.rst b/docs/reference/api/resources/images.rst
@@ -8,9 +8,6 @@ Image
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Image|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 
 An image is graphical content of arbitrary size.
 

diff --git a/docs/reference/api/widgets/activityindicator.rst b/docs/reference/api/widgets/activityindicator.rst
@@ -8,9 +8,6 @@ Activity Indicator
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(ActivityIndicator|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The activity indicator is a (spinning) animation for showing progress in an indeterminate task.
 
 Usage

diff --git a/docs/reference/api/widgets/button.rst b/docs/reference/api/widgets/button.rst
@@ -18,9 +18,6 @@ Availability
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Button|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 Usage
 -----
 

diff --git a/docs/reference/api/widgets/canvas.rst b/docs/reference/api/widgets/canvas.rst
@@ -8,9 +8,6 @@ Canvas
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Canvas|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The canvas is used for creating a blank widget that you can draw on.
 
 Usage

diff --git a/docs/reference/api/widgets/detailedlist.rst b/docs/reference/api/widgets/detailedlist.rst
@@ -8,9 +8,6 @@ DetailedList
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(DetailedList|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 
 
 Usage

diff --git a/docs/reference/api/widgets/divider.rst b/docs/reference/api/widgets/divider.rst
@@ -8,9 +8,6 @@ Divider
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Divider|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The divider is used to visually separate sections of a user layout with a line.
 
 Usage

diff --git a/docs/reference/api/widgets/imageview.rst b/docs/reference/api/widgets/imageview.rst
@@ -8,9 +8,6 @@ Image View
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(ImageView|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The Image View is a container for an image to be rendered on the display
 
 Usage

diff --git a/docs/reference/api/widgets/label.rst b/docs/reference/api/widgets/label.rst
@@ -15,9 +15,6 @@ Availability
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(Label|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 Usage
 -----
 

diff --git a/docs/reference/api/widgets/multilinetextinput.rst b/docs/reference/api/widgets/multilinetextinput.rst
@@ -8,9 +8,6 @@ Multi-line text input
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(MultilineTextInput|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The Multi-line text input is similar to the text input but designed for larger inputs, similar to the textarea field of HTML.
 
 Usage

diff --git a/docs/reference/api/widgets/numberinput.rst b/docs/reference/api/widgets/numberinput.rst
@@ -8,9 +8,6 @@ Number Input
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(NumberInput|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The Number input is a text input box that is limited to numeric input.
 
 .. figure:: /reference/images/NumberInput.jpeg

diff --git a/docs/reference/api/widgets/passwordinput.rst b/docs/reference/api/widgets/passwordinput.rst
@@ -8,9 +8,6 @@ PasswordInput
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(PasswordInput|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 
 Usage
 -----

diff --git a/docs/reference/api/widgets/progressbar.rst b/docs/reference/api/widgets/progressbar.rst
@@ -8,9 +8,6 @@ Progress Bar
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(ProgressBar|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The progress bar is a simple widget for showing a percentage progress for task completion.
 
 Usage

diff --git a/docs/reference/api/widgets/selection.rst b/docs/reference/api/widgets/selection.rst
@@ -8,9 +8,6 @@ Selection
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(Selection|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The Selection widget is a simple control for allowing the user to choose between a list of string options.
 
 .. figure:: /reference/images/Selection.jpeg

diff --git a/docs/reference/api/widgets/slider.rst b/docs/reference/api/widgets/slider.rst
@@ -8,9 +8,6 @@ Slider
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(Slider|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 
 
 Usage

diff --git a/docs/reference/api/widgets/switch.rst b/docs/reference/api/widgets/switch.rst
@@ -8,9 +8,6 @@ Switch
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(Switch|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The switch widget is a clickable button with two stable states, True (on,
 checked) and False (off, unchecked).
 

diff --git a/docs/reference/api/widgets/table.rst b/docs/reference/api/widgets/table.rst
@@ -8,9 +8,6 @@ Table
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(Table|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The table widget is a widget for displaying tabular data. It can be instantiated with the list of headings and then data rows
 can be added.
 

diff --git a/docs/reference/api/widgets/textinput.rst b/docs/reference/api/widgets/textinput.rst
@@ -8,9 +8,6 @@ Text Input
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(TextInput|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The text input widget is a simple input field for user entry of text data.
 
 .. figure:: /reference/images/TextInput.jpeg

diff --git a/docs/reference/api/widgets/tree.rst b/docs/reference/api/widgets/tree.rst
@@ -8,9 +8,6 @@ Tree
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(Tree|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The tree widget is still under development.
 
 Usage

diff --git a/docs/reference/api/widgets/webview.rst b/docs/reference/api/widgets/webview.rst
@@ -8,9 +8,6 @@ WebView
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(WebView|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The Web View widget is used for displaying an embedded browser window within an application.
 
 Both sites served by a web server and local content can be displayed. Due to security

diff --git a/docs/reference/api/widgets/widget.rst b/docs/reference/api/widgets/widget.rst
@@ -8,9 +8,6 @@ Widget
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!^(Widget|Component)$)'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 The base class of all widgets. This class should not be be instantiated directly.
 
 Reference

diff --git a/docs/reference/api/window.rst b/docs/reference/api/window.rst
@@ -8,9 +8,6 @@ Window
    :included_cols: 4,5,6,7,8,9
    :exclude: {0: '(?!(Window|Component))'}
 
-.. |y| image:: /_static/yes.png
-    :width: 16
-
 A window for displaying components to the user
 
 Usage