Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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/3818.doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The links on the APIs by platform docs page have been standardized to match their equivalents in the main API reference index: plain text rather than code-formatted, and linking to the top of their respective pages rather than to anchors for the specific classes.
1 change: 1 addition & 0 deletions changes/3836.misc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The information and display mechanisms relating to API components have been consolidated, to ease maintenance and reduce likelihood of drift.
1 change: 0 additions & 1 deletion docs/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ plugins:
literate-nav:
nav_file: SUMMARY.md
macros: {}
table-reader: {}
mkdocstrings:
enable_inventory: true
default_handler: python
Expand Down
9 changes: 1 addition & 8 deletions docs/en/reference/api/app.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# App

The top-level representation of an application.

Availability ([Key][api-status-key]) <!-- rumdl-disable-line MD013 -->
{: .availability-title }

{{ pd_read_csv("../data/widgets_by_platform.csv", na_filter=False, usecols=[4,5,6,7,8,9,10])[pd_read_csv("../data/widgets_by_platform.csv")[["ComponentName"]].isin(["Application"]).all(axis=1)] | convert_to_md_table }}
{{ component_header("App") }}

## Usage

Expand Down
4 changes: 3 additions & 1 deletion docs/en/reference/api/constants.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Constants
{{ component_header("Constants") }}

## Reference

::: toga.constants
options:
Expand Down
9 changes: 1 addition & 8 deletions docs/en/reference/api/containers/box.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# Box

A generic container for other widgets. Used to construct layouts.

Availability ([Key][api-status-key]) <!-- rumdl-disable-line MD013 -->
{: .availability-title }

{{ pd_read_csv("../../data/widgets_by_platform.csv", na_filter=False, usecols=[4,5,6,7,8,9,10])[pd_read_csv("../../data/widgets_by_platform.csv")[["ComponentName"]].isin(["Box"]).all(axis=1)] | convert_to_md_table }}
{{ component_header("Box") }}

## Usage

Expand Down
76 changes: 1 addition & 75 deletions docs/en/reference/api/containers/optioncontainer.md
Original file line number Diff line number Diff line change
@@ -1,78 +1,4 @@
# OptionContainer

A container that can display multiple labeled tabs of content.

/// tab | macOS

![/reference/images/optioncontainer-cocoa.png](/reference/images/optioncontainer-cocoa.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Linux

![/reference/images/optioncontainer-gtk.png](/reference/images/optioncontainer-gtk.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Windows

![/reference/images/optioncontainer-winforms.png](/reference/images/optioncontainer-winforms.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Android

![/reference/images/optioncontainer-android.png](/reference/images/optioncontainer-android.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | iOS

![/reference/images/optioncontainer-iOS.png](/reference/images/optioncontainer-iOS.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Web {{ not_supported }}

Not supported

///

/// tab | Textual {{ not_supported }}

Not supported

///
{{ component_header("OptionContainer", width=450) }}

## Usage

Expand Down
82 changes: 1 addition & 81 deletions docs/en/reference/api/containers/scrollcontainer.md
Original file line number Diff line number Diff line change
@@ -1,84 +1,4 @@
# ScrollContainer

A container that can display a layout larger than the area of the container, with overflow controlled by scroll bars.

/// tab | macOS

![/reference/images/scrollcontainer-cocoa.png](/reference/images/scrollcontainer-cocoa.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Linux

![/reference/images/scrollcontainer-gtk.png](/reference/images/scrollcontainer-gtk.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Windows

![/reference/images/scrollcontainer-winforms.png](/reference/images/scrollcontainer-winforms.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Android

![/reference/images/scrollcontainer-android.png](/reference/images/scrollcontainer-android.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | iOS

![/reference/images/scrollcontainer-iOS.png](/reference/images/scrollcontainer-iOS.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Web

![/reference/images/scrollcontainer-web.png](/reference/images/scrollcontainer-web.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Textual {{ not_supported }}

Not supported

///
{{ component_header("ScrollContainer", width=450) }}

## Usage

Expand Down
64 changes: 1 addition & 63 deletions docs/en/reference/api/containers/splitcontainer.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,4 @@
# SplitContainer

A container that divides an area into two panels with a movable border.

/// tab | macOS

![/reference/images/splitcontainer-cocoa.png](/reference/images/splitcontainer-cocoa.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Linux

![/reference/images/splitcontainer-gtk.png](/reference/images/splitcontainer-gtk.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Windows

![/reference/images/splitcontainer-winforms.png](/reference/images/splitcontainer-winforms.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Android {{ not_supported }}

Not supported

///

/// tab | iOS {{ not_supported }}

Not supported

///

/// tab | Web {{ not_supported }}

Not supported

///

/// tab | Textual {{ not_supported }}

Not supported

///
{{ component_header("SplitContainer", width=450) }}

## Usage

Expand Down
64 changes: 1 addition & 63 deletions docs/en/reference/api/documentwindow.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,4 @@
# DocumentWindow

A window that can be used as the main interface to a document-based app.

/// tab | macOS

![/reference/images/mainwindow-cocoa.png](/reference/images/mainwindow-cocoa.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Linux

![/reference/images/mainwindow-gtk.png](/reference/images/mainwindow-gtk.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Windows

![/reference/images/mainwindow-winforms.png](/reference/images/mainwindow-winforms.png){ width="450" }

/// caption

///

<!-- TODO: Update alt text -->

///

/// tab | Android {{ not_supported }}

Not supported

///

/// tab | iOS {{ not_supported }}

Not supported

///

/// tab | Web {{ not_supported }}

Not supported

///

/// tab | Textual {{ not_supported }}

Not supported

///
{{ component_header("DocumentWindow", width=450, alt_file="mainwindow") }}

## Usage

Expand Down
9 changes: 1 addition & 8 deletions docs/en/reference/api/hardware/camera.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# Camera

A sensor that can capture photos and/or video.

Availability ([Key][api-status-key]) <!-- rumdl-disable-line MD013 -->
{: .availability-title }

{{ pd_read_csv("../../data/widgets_by_platform.csv", na_filter=False, usecols=[4,5,6,7,8,9,10])[pd_read_csv("../../data/widgets_by_platform.csv")[["ComponentName"]].isin(["Camera"]).all(axis=1)] | convert_to_md_table }}
{{ component_header("Camera") }}

## Usage

Expand Down
9 changes: 1 addition & 8 deletions docs/en/reference/api/hardware/location.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# Location services

A sensor that can capture the geographical location of the device.

Availability ([Key][api-status-key]) <!-- rumdl-disable-line MD013 -->
{: .availability-title }

{{ pd_read_csv("../../data/widgets_by_platform.csv", na_filter=False, usecols=[4,5,6,7,8,9,10])[pd_read_csv("../../data/widgets_by_platform.csv")[["ComponentName"]].isin(["Location"]).all(axis=1)] | convert_to_md_table }}
{{ component_header("Location services") }}

## Usage

Expand Down
9 changes: 1 addition & 8 deletions docs/en/reference/api/hardware/screens.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# Screen

A representation of a screen attached to a device.

Availability ([Key][api-status-key]) <!-- rumdl-disable-line MD013 -->
{: .availability-title }

{{ pd_read_csv("../../data/widgets_by_platform.csv", na_filter=False, usecols=[4,5,6,7,8,9,10])[pd_read_csv("../../data/widgets_by_platform.csv")[["ComponentName"]].isin(["Screen"]).all(axis=1)] | convert_to_md_table }}
{{ component_header("Screen") }}

## Usage

Expand Down
Loading