added doc indexes

This commit is contained in:
Will McGugan
2022-09-06 13:11:06 +01:00
parent 3e41e14714
commit 9aa7228fda
8 changed files with 35 additions and 5 deletions

3
docs/events/index.md Normal file
View File

@@ -0,0 +1,3 @@
# Events
A reference to Textual [events](../guide/events.md).

9
docs/guide/index.md Normal file
View File

@@ -0,0 +1,9 @@
# Textual Guide
Welcome to the Textual Guide! An in-depth reference on how to build app with Textual.
## Example code
Most of the code in this guide is fully working—you could cut and paste it if you wanted to.
Although it is probably easier to check out the [Textual repository](https://github.com/Textualize/textual) and navigate to the `docs/examples/guide` directory and run the examples from there.

3
docs/how-to/index.md Normal file
View File

@@ -0,0 +1,3 @@
# How to ...
For those who want more focused information on Textual features.

3
docs/reference/index.md Normal file
View File

@@ -0,0 +1,3 @@
# Reference
A reference to the Textual public APIs.

3
docs/styles/index.md Normal file
View File

@@ -0,0 +1,3 @@
# Styles
A reference to Widget [styles](../guide/styles.md).

3
docs/widgets/index.md Normal file
View File

@@ -0,0 +1,3 @@
# Widgets
A reference to the builtin [widgets](../guide/widgets.md).

View File

@@ -6,6 +6,7 @@ nav:
- "getting_started.md"
- "tutorial.md"
- Guide:
- "guide/index.md"
- "guide/devtools.md"
- "guide/app.md"
- "guide/styles.md"
@@ -17,11 +18,12 @@ nav:
- "guide/widgets.md"
- "guide/screens.md"
- How to:
- "how-to/index.md"
- "how-to/animation.md"
- "how-to/mouse-and-keyboard.md"
- "how-to/scroll.md"
- "actions.md"
- "how-to/scroll.md"
- Events:
- "events/index.md"
- "events/blur.md"
- "events/descendant_blur.md"
- "events/descendant_focus.md"
@@ -47,6 +49,7 @@ nav:
- "events/screen_suspend.md"
- "events/show.md"
- Styles:
- "styles/index.md"
- "styles/background.md"
- "styles/border.md"
- "styles/box_sizing.md"
@@ -75,6 +78,7 @@ nav:
- "styles/visibility.md"
- "styles/width.md"
- Widgets:
- "widgets/index.md"
- "widgets/button.md"
- "widgets/data_table.md"
- "widgets/footer.md"
@@ -82,6 +86,7 @@ nav:
- "widgets/static.md"
- "widgets/tree_control.md"
- Reference:
- "reference/index.md"
- "reference/app.md"
- "reference/button.md"
- "reference/color.md"
@@ -128,8 +133,9 @@ markdown_extensions:
theme:
name: material
custom_dir: custom_theme
# features:
# - navigation.tabs
features:
- navigation.tabs
- navigation.indexes
palette:
- media: "(prefers-color-scheme: light)"
scheme: default

2
poetry.lock generated
View File

@@ -345,7 +345,7 @@ mkdocs = ">=1.1"
[[package]]
name = "mkdocs-material"
version = "8.4.1"
version = "8.4.2"
description = "Documentation that simply works"
category = "dev"
optional = false