Add docs for Pretty, fix some reference issues in docs (#2678)

This commit is contained in:
darrenburns
2023-05-29 17:11:39 +01:00
committed by GitHub
parent 73d55725b5
commit ca17d8194e
9 changed files with 83 additions and 5 deletions

44
docs/widgets/pretty.md Normal file
View File

@@ -0,0 +1,44 @@
# Pretty
Display a pretty-formatted object.
- [ ] Focusable
- [ ] Container
## Example
The example below shows a pretty-formatted `dict`, but `Pretty` can display any Python object.
=== "Output"
```{.textual path="docs/examples/widgets/pretty.py"}
```
=== "pretty.py"
```python
--8<-- "docs/examples/widgets/pretty.py"
```
## Reactive Attributes
This widget has no reactive attributes.
## Messages
This widget posts no messages.
## Bindings
This widget has no bindings.
## Component Classes
This widget has no component classes.
---
::: textual.widgets.Pretty
options:
heading_level: 2

View File

@@ -32,6 +32,7 @@ This widget sends no messages.
## See Also
* [Label](./label.md)
* [Pretty](./pretty.md)
---