summaryrefslogtreecommitdiffstats
path: root/docs/source/reference
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-14 20:18:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-14 20:18:28 +0000
commitf8363b456f1ab31ee56abad579b215af195093d5 (patch)
treeb1500c675c2e0a55fb75721a854e1510acf7c862 /docs/source/reference
parentInitial commit. (diff)
downloadrich-upstream.tar.xz
rich-upstream.zip
Adding upstream version 9.11.0.upstream/9.11.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--docs/source/reference.rst39
-rw-r--r--docs/source/reference/abc.rst7
-rw-r--r--docs/source/reference/align.rst7
-rw-r--r--docs/source/reference/bar.rst7
-rw-r--r--docs/source/reference/color.rst7
-rw-r--r--docs/source/reference/columns.rst7
-rw-r--r--docs/source/reference/console.rst5
-rw-r--r--docs/source/reference/emoji.rst6
-rw-r--r--docs/source/reference/highlighter.rst7
-rw-r--r--docs/source/reference/init.rst7
-rw-r--r--docs/source/reference/live.rst5
-rw-r--r--docs/source/reference/logging.rst8
-rw-r--r--docs/source/reference/markdown.rst7
-rw-r--r--docs/source/reference/markup.rst5
-rw-r--r--docs/source/reference/measure.rst5
-rw-r--r--docs/source/reference/padding.rst5
-rw-r--r--docs/source/reference/panel.rst6
-rw-r--r--docs/source/reference/pretty.rst6
-rw-r--r--docs/source/reference/progress.rst5
-rw-r--r--docs/source/reference/progress_bar.rst7
-rw-r--r--docs/source/reference/prompt.rst5
-rw-r--r--docs/source/reference/protocol.rst5
-rw-r--r--docs/source/reference/rule.rst5
-rw-r--r--docs/source/reference/segment.rst5
-rw-r--r--docs/source/reference/spinner.rst5
-rw-r--r--docs/source/reference/status.rst5
-rw-r--r--docs/source/reference/style.rst7
-rw-r--r--docs/source/reference/styled.rst7
-rw-r--r--docs/source/reference/syntax.rst5
-rw-r--r--docs/source/reference/table.rst5
-rw-r--r--docs/source/reference/text.rst6
-rw-r--r--docs/source/reference/theme.rst6
-rw-r--r--docs/source/reference/traceback.rst6
-rw-r--r--docs/source/reference/tree.rst5
34 files changed, 235 insertions, 0 deletions
diff --git a/docs/source/reference.rst b/docs/source/reference.rst
new file mode 100644
index 0000000..d16047a
--- /dev/null
+++ b/docs/source/reference.rst
@@ -0,0 +1,39 @@
+Reference
+=========
+
+.. toctree::
+ :maxdepth: 3
+
+ reference/align.rst
+ reference/bar.rst
+ reference/color.rst
+ reference/columns.rst
+ reference/console.rst
+ reference/emoji.rst
+ reference/highlighter.rst
+ reference/init.rst
+ reference/live.rst
+ reference/logging.rst
+ reference/markdown.rst
+ reference/markup.rst
+ reference/measure.rst
+ reference/padding.rst
+ reference/panel.rst
+ reference/pretty.rst
+ reference/progress_bar.rst
+ reference/progress.rst
+ reference/prompt.rst
+ reference/protocol.rst
+ reference/rule.rst
+ reference/segment.rst
+ reference/spinner.rst
+ reference/status.rst
+ reference/style.rst
+ reference/styled.rst
+ reference/syntax.rst
+ reference/table.rst
+ reference/text.rst
+ reference/theme.rst
+ reference/traceback.rst
+ reference/tree.rst
+ reference/abc.rst
diff --git a/docs/source/reference/abc.rst b/docs/source/reference/abc.rst
new file mode 100644
index 0000000..c4e3758
--- /dev/null
+++ b/docs/source/reference/abc.rst
@@ -0,0 +1,7 @@
+rich.abc
+========
+
+.. automodule:: rich.abc
+ :members:
+
+
diff --git a/docs/source/reference/align.rst b/docs/source/reference/align.rst
new file mode 100644
index 0000000..54b0525
--- /dev/null
+++ b/docs/source/reference/align.rst
@@ -0,0 +1,7 @@
+rich.align
+==========
+
+.. automodule:: rich.align
+ :members:
+
+
diff --git a/docs/source/reference/bar.rst b/docs/source/reference/bar.rst
new file mode 100644
index 0000000..6a247d7
--- /dev/null
+++ b/docs/source/reference/bar.rst
@@ -0,0 +1,7 @@
+rich.bar
+========
+
+.. automodule:: rich.bar
+ :members:
+
+
diff --git a/docs/source/reference/color.rst b/docs/source/reference/color.rst
new file mode 100644
index 0000000..87b0e18
--- /dev/null
+++ b/docs/source/reference/color.rst
@@ -0,0 +1,7 @@
+rich.color
+==========
+
+.. automodule:: rich.color
+ :members:
+
+
diff --git a/docs/source/reference/columns.rst b/docs/source/reference/columns.rst
new file mode 100644
index 0000000..14bcd02
--- /dev/null
+++ b/docs/source/reference/columns.rst
@@ -0,0 +1,7 @@
+rich.columns
+============
+
+.. automodule:: rich.columns
+ :members:
+
+
diff --git a/docs/source/reference/console.rst b/docs/source/reference/console.rst
new file mode 100644
index 0000000..26ec6ff
--- /dev/null
+++ b/docs/source/reference/console.rst
@@ -0,0 +1,5 @@
+rich.console
+============
+
+.. automodule:: rich.console
+ :members:
diff --git a/docs/source/reference/emoji.rst b/docs/source/reference/emoji.rst
new file mode 100644
index 0000000..59ca4da
--- /dev/null
+++ b/docs/source/reference/emoji.rst
@@ -0,0 +1,6 @@
+rich.emoji
+==========
+
+.. automodule:: rich.emoji
+ :members: Emoji
+
diff --git a/docs/source/reference/highlighter.rst b/docs/source/reference/highlighter.rst
new file mode 100644
index 0000000..7f5a11f
--- /dev/null
+++ b/docs/source/reference/highlighter.rst
@@ -0,0 +1,7 @@
+rich.highlighter
+================
+
+.. automodule:: rich.highlighter
+ :members:
+ :special-members: __call__
+
diff --git a/docs/source/reference/init.rst b/docs/source/reference/init.rst
new file mode 100644
index 0000000..3ac3fda
--- /dev/null
+++ b/docs/source/reference/init.rst
@@ -0,0 +1,7 @@
+rich
+====
+
+.. automodule:: rich
+ :members:
+
+
diff --git a/docs/source/reference/live.rst b/docs/source/reference/live.rst
new file mode 100644
index 0000000..516ed8f
--- /dev/null
+++ b/docs/source/reference/live.rst
@@ -0,0 +1,5 @@
+rich.live
+=========
+
+.. automodule:: rich.live
+ :members: \ No newline at end of file
diff --git a/docs/source/reference/logging.rst b/docs/source/reference/logging.rst
new file mode 100644
index 0000000..a7caafc
--- /dev/null
+++ b/docs/source/reference/logging.rst
@@ -0,0 +1,8 @@
+.. _logging:
+
+rich.logging
+============
+
+.. automodule:: rich.logging
+ :members: RichHandler
+
diff --git a/docs/source/reference/markdown.rst b/docs/source/reference/markdown.rst
new file mode 100644
index 0000000..b98f558
--- /dev/null
+++ b/docs/source/reference/markdown.rst
@@ -0,0 +1,7 @@
+rich.markdown
+=============
+
+.. automodule:: rich.markdown
+ :members:
+
+
diff --git a/docs/source/reference/markup.rst b/docs/source/reference/markup.rst
new file mode 100644
index 0000000..ff786f2
--- /dev/null
+++ b/docs/source/reference/markup.rst
@@ -0,0 +1,5 @@
+rich.markup
+===========
+
+.. automodule:: rich.markup
+ :members:
diff --git a/docs/source/reference/measure.rst b/docs/source/reference/measure.rst
new file mode 100644
index 0000000..c048eb1
--- /dev/null
+++ b/docs/source/reference/measure.rst
@@ -0,0 +1,5 @@
+rich.measure
+============
+
+.. automodule:: rich.measure
+ :members:
diff --git a/docs/source/reference/padding.rst b/docs/source/reference/padding.rst
new file mode 100644
index 0000000..e047ca9
--- /dev/null
+++ b/docs/source/reference/padding.rst
@@ -0,0 +1,5 @@
+rich.padding
+============
+
+.. automodule:: rich.padding
+ :members:
diff --git a/docs/source/reference/panel.rst b/docs/source/reference/panel.rst
new file mode 100644
index 0000000..998f290
--- /dev/null
+++ b/docs/source/reference/panel.rst
@@ -0,0 +1,6 @@
+rich.panel
+==========
+
+.. automodule:: rich.panel
+ :members: Panel
+
diff --git a/docs/source/reference/pretty.rst b/docs/source/reference/pretty.rst
new file mode 100644
index 0000000..4290dbd
--- /dev/null
+++ b/docs/source/reference/pretty.rst
@@ -0,0 +1,6 @@
+rich.pretty
+===========
+
+.. automodule:: rich.pretty
+ :members:
+
diff --git a/docs/source/reference/progress.rst b/docs/source/reference/progress.rst
new file mode 100644
index 0000000..69551b2
--- /dev/null
+++ b/docs/source/reference/progress.rst
@@ -0,0 +1,5 @@
+rich.progress
+=============
+
+.. automodule:: rich.progress
+ :members:
diff --git a/docs/source/reference/progress_bar.rst b/docs/source/reference/progress_bar.rst
new file mode 100644
index 0000000..6e5a201
--- /dev/null
+++ b/docs/source/reference/progress_bar.rst
@@ -0,0 +1,7 @@
+rich.progress_bar
+=================
+
+.. automodule:: rich.progress_bar
+ :members:
+
+
diff --git a/docs/source/reference/prompt.rst b/docs/source/reference/prompt.rst
new file mode 100644
index 0000000..d5adef4
--- /dev/null
+++ b/docs/source/reference/prompt.rst
@@ -0,0 +1,5 @@
+rich.prompt
+===========
+
+.. automodule:: rich.prompt
+ :members:
diff --git a/docs/source/reference/protocol.rst b/docs/source/reference/protocol.rst
new file mode 100644
index 0000000..4febcee
--- /dev/null
+++ b/docs/source/reference/protocol.rst
@@ -0,0 +1,5 @@
+rich.protocol
+=============
+
+.. automodule:: rich.protocol
+ :members:
diff --git a/docs/source/reference/rule.rst b/docs/source/reference/rule.rst
new file mode 100644
index 0000000..f06eb3a
--- /dev/null
+++ b/docs/source/reference/rule.rst
@@ -0,0 +1,5 @@
+rich.rule
+=========
+
+.. automodule:: rich.rule
+ :members:
diff --git a/docs/source/reference/segment.rst b/docs/source/reference/segment.rst
new file mode 100644
index 0000000..fce383c
--- /dev/null
+++ b/docs/source/reference/segment.rst
@@ -0,0 +1,5 @@
+rich.segment
+============
+
+.. automodule:: rich.segment
+ :members:
diff --git a/docs/source/reference/spinner.rst b/docs/source/reference/spinner.rst
new file mode 100644
index 0000000..53315dc
--- /dev/null
+++ b/docs/source/reference/spinner.rst
@@ -0,0 +1,5 @@
+rich.spinner
+============
+
+.. automodule:: rich.spinner
+ :members:
diff --git a/docs/source/reference/status.rst b/docs/source/reference/status.rst
new file mode 100644
index 0000000..ac4704e
--- /dev/null
+++ b/docs/source/reference/status.rst
@@ -0,0 +1,5 @@
+rich.status
+============
+
+.. automodule:: rich.status
+ :members:
diff --git a/docs/source/reference/style.rst b/docs/source/reference/style.rst
new file mode 100644
index 0000000..3d431ac
--- /dev/null
+++ b/docs/source/reference/style.rst
@@ -0,0 +1,7 @@
+rich.style
+==========
+
+.. automodule:: rich.style
+ :members:
+ :special-members: __call__
+
diff --git a/docs/source/reference/styled.rst b/docs/source/reference/styled.rst
new file mode 100644
index 0000000..6720726
--- /dev/null
+++ b/docs/source/reference/styled.rst
@@ -0,0 +1,7 @@
+rich.styled
+===========
+
+.. automodule:: rich.styled
+ :members:
+
+
diff --git a/docs/source/reference/syntax.rst b/docs/source/reference/syntax.rst
new file mode 100644
index 0000000..c8e4918
--- /dev/null
+++ b/docs/source/reference/syntax.rst
@@ -0,0 +1,5 @@
+rich.syntax
+===========
+
+.. automodule:: rich.syntax
+ :members: Syntax
diff --git a/docs/source/reference/table.rst b/docs/source/reference/table.rst
new file mode 100644
index 0000000..40562b0
--- /dev/null
+++ b/docs/source/reference/table.rst
@@ -0,0 +1,5 @@
+rich.table
+==========
+
+.. automodule:: rich.table
+ :members:
diff --git a/docs/source/reference/text.rst b/docs/source/reference/text.rst
new file mode 100644
index 0000000..76b41f4
--- /dev/null
+++ b/docs/source/reference/text.rst
@@ -0,0 +1,6 @@
+rich.text
+=========
+
+.. automodule:: rich.text
+ :members: Text
+
diff --git a/docs/source/reference/theme.rst b/docs/source/reference/theme.rst
new file mode 100644
index 0000000..14fb919
--- /dev/null
+++ b/docs/source/reference/theme.rst
@@ -0,0 +1,6 @@
+rich.theme
+==========
+
+.. automodule:: rich.theme
+ :members: Theme
+
diff --git a/docs/source/reference/traceback.rst b/docs/source/reference/traceback.rst
new file mode 100644
index 0000000..cdd09fb
--- /dev/null
+++ b/docs/source/reference/traceback.rst
@@ -0,0 +1,6 @@
+rich.traceback
+==============
+
+.. automodule:: rich.traceback
+ :members: Traceback, install
+
diff --git a/docs/source/reference/tree.rst b/docs/source/reference/tree.rst
new file mode 100644
index 0000000..4024041
--- /dev/null
+++ b/docs/source/reference/tree.rst
@@ -0,0 +1,5 @@
+rich.tree
+=========
+
+.. automodule:: rich.tree
+ :members: