Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Distinguish beta from stable support in docs #1762

Merged
merged 6 commits into from
Feb 4, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/1762.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
API support tables now indicate beta status using a dimmed check mark.
32 changes: 24 additions & 8 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -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"]) {
freakboy3742 marked this conversation as resolved.
Show resolved Hide resolved
--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;
}
Copy link
Member Author

@mhsmith mhsmith Jan 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These rules weren't previously working because the CSS class is on the div, not the table.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the reason they weren't working was that there was no div.body. The CSS class is on both elements, but in case this changes in the future, I've now removed the element name, leaving only the class.


span.stable {
font-weight: bold;
}

span.beta {
font-weight: bold;
color: var(--color-beta);
}
Binary file removed docs/_static/yes.png
Binary file not shown.
8 changes: 8 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 ---------------------------------------------------

Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/containers/box.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/containers/optioncontainer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/containers/scrollcontainer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/containers/splitcontainer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,6 @@ Resources
:doc:`Image </reference/api/resources/images>` An image
=================================================== =================================

.. |y| image:: /_static/yes.png
:width: 16

.. toctree::
:hidden:

Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/mainwindow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/resources/command.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/resources/fonts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/resources/group.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/resources/icons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/resources/images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/activityindicator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/button.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----

Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/canvas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/detailedlist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/divider.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/imageview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/label.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----

Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/multilinetextinput.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/numberinput.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/passwordinput.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/progressbar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/selection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/slider.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/switch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/textinput.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/tree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/webview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/widgets/widget.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/api/window.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading