api docs (#2240)

* api docs * more docstrings * logs * docs shakeup * fix notes, added intro to all apis * Remove defaults to * add note to events * note * use fira code
2025-10-17 02:38:12 +03:00 · 2023-04-08 15:35:49 +01:00
parent 5726a20e8e
commit 2244b1161e
103 changed files with 879 additions and 557 deletions
--- a/docs/api/button.md
+++ b/docs/api/button.md
@@ -1,3 +0,0 @@
-::: textual.widgets.Button
-::: textual.widgets._button.ButtonVariant
-::: textual.widgets._button.InvalidButtonVariant
--- a/docs/api/checkbox.md
+++ b/docs/api/checkbox.md
@@ -1 +0,0 @@
-::: textual.widgets.Checkbox
--- a/docs/api/data_table.md
+++ b/docs/api/data_table.md
@@ -1 +0,0 @@
-::: textual.widgets.DataTable
--- a/docs/api/directory_tree.md
+++ b/docs/api/directory_tree.md
@@ -1 +0,0 @@
-::: textual.widgets.DirectoryTree
--- a/docs/api/footer.md
+++ b/docs/api/footer.md
@@ -1 +0,0 @@
-::: textual.widgets.Footer
--- a/docs/api/header.md
+++ b/docs/api/header.md
@@ -1 +0,0 @@
-::: textual.widgets.Header
--- a/docs/api/input.md
+++ b/docs/api/input.md
@@ -1 +0,0 @@
-::: textual.widgets.Input
--- a/docs/api/label.md
+++ b/docs/api/label.md
@@ -1 +0,0 @@
-::: textual.widgets.Label
--- a/docs/api/list_item.md
+++ b/docs/api/list_item.md
@@ -1 +0,0 @@
-::: textual.widgets.ListItem
--- a/docs/api/list_view.md
+++ b/docs/api/list_view.md
@@ -1 +0,0 @@
-::: textual.widgets.ListView
--- a/docs/api/loading_indicator.md
+++ b/docs/api/loading_indicator.md
@@ -1 +0,0 @@
-::: textual.widgets.LoadingIndicator
--- a/docs/api/logger.md
+++ b/docs/api/logger.md
@@ -0,0 +1 @@
+::: textual.Logger
--- a/docs/api/markdown.md
+++ b/docs/api/markdown.md
@@ -1 +0,0 @@
-::: textual.widgets.Markdown
--- a/docs/api/markdown_viewer.md
+++ b/docs/api/markdown_viewer.md
@@ -1 +0,0 @@
-::: textual.widgets.MarkdownViewer
--- a/docs/api/message_pump.md
+++ b/docs/api/message_pump.md
@@ -1,5 +1 @@
-A message pump is a class that processes messages.
-
-It is a base class for the `App`, `Screen`, and `Widget` classes.
-
 ::: textual.message_pump
--- a/docs/api/option_list.md
+++ b/docs/api/option_list.md
@@ -1,3 +0,0 @@
-::: textual.widgets.OptionList
-::: textual.widgets._option_list.Option
-::: textual.widgets._option_list.Separator
--- a/docs/api/placeholder.md
+++ b/docs/api/placeholder.md
@@ -1,2 +0,0 @@
-::: textual.widgets.Placeholder
-::: textual.widgets._placeholder.PlaceholderVariant
--- a/docs/api/radiobutton.md
+++ b/docs/api/radiobutton.md
@@ -1 +0,0 @@
-::: textual.widgets.RadioButton
--- a/docs/api/radioset.md
+++ b/docs/api/radioset.md
@@ -1 +0,0 @@
-::: textual.widgets.RadioSet
--- a/docs/api/static.md
+++ b/docs/api/static.md
@@ -1 +0,0 @@
-::: textual.widgets.Static
--- a/docs/api/switch.md
+++ b/docs/api/switch.md
@@ -1 +0,0 @@
-::: textual.widgets.Switch
--- a/docs/api/tabbed_content.md
+++ b/docs/api/tabbed_content.md
@@ -1,2 +0,0 @@
-::: textual.widgets.TabbedContent
-::: textual.widgets.TabPane
--- a/docs/api/tabs.md
+++ b/docs/api/tabs.md
@@ -1,2 +0,0 @@
-::: textual.widgets.Tab
-::: textual.widgets.Tabs
--- a/docs/api/text_log.md
+++ b/docs/api/text_log.md
@@ -1 +0,0 @@
-::: textual.widgets.TextLog
--- a/docs/api/toggle_button.md
+++ b/docs/api/toggle_button.md
@@ -1 +0,0 @@
-::: textual.widgets._toggle_button.ToggleButton
--- a/docs/api/tree.md
+++ b/docs/api/tree.md
@@ -1,4 +0,0 @@
-::: textual.widgets.Tree
-::: textual.widgets._tree.TreeNode
-::: textual.widgets._tree.NodeID
-::: textual.widgets._tree.TreeDataType
--- a/docs/api/welcome.md
+++ b/docs/api/welcome.md
@@ -1 +0,0 @@
-::: textual.widgets.Welcome
--- a/docs/api/work.md
+++ b/docs/api/work.md
@@ -1 +1,2 @@
+
 ::: textual.work
				`@@ -1 +0,0 @@`
				`::: textual.widgets._toggle_button.ToggleButton`