From 9aa7228fda82432126d75a4767ef047753ba724c Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Tue, 6 Sep 2022 13:11:06 +0100 Subject: [PATCH] added doc indexes --- docs/events/index.md | 3 +++ docs/guide/index.md | 9 +++++++++ docs/how-to/index.md | 3 +++ docs/reference/index.md | 3 +++ docs/styles/index.md | 3 +++ docs/widgets/index.md | 3 +++ mkdocs.yml | 14 ++++++++++---- poetry.lock | 2 +- 8 files changed, 35 insertions(+), 5 deletions(-) create mode 100644 docs/events/index.md create mode 100644 docs/guide/index.md create mode 100644 docs/how-to/index.md create mode 100644 docs/reference/index.md create mode 100644 docs/styles/index.md create mode 100644 docs/widgets/index.md diff --git a/docs/events/index.md b/docs/events/index.md new file mode 100644 index 000000000..5b3430c34 --- /dev/null +++ b/docs/events/index.md @@ -0,0 +1,3 @@ +# Events + +A reference to Textual [events](../guide/events.md). diff --git a/docs/guide/index.md b/docs/guide/index.md new file mode 100644 index 000000000..10c6e3a0f --- /dev/null +++ b/docs/guide/index.md @@ -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. diff --git a/docs/how-to/index.md b/docs/how-to/index.md new file mode 100644 index 000000000..48a0aac26 --- /dev/null +++ b/docs/how-to/index.md @@ -0,0 +1,3 @@ +# How to ... + +For those who want more focused information on Textual features. diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 000000000..8e129acd1 --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,3 @@ +# Reference + +A reference to the Textual public APIs. diff --git a/docs/styles/index.md b/docs/styles/index.md new file mode 100644 index 000000000..67b6f6c85 --- /dev/null +++ b/docs/styles/index.md @@ -0,0 +1,3 @@ +# Styles + +A reference to Widget [styles](../guide/styles.md). diff --git a/docs/widgets/index.md b/docs/widgets/index.md new file mode 100644 index 000000000..90c80104e --- /dev/null +++ b/docs/widgets/index.md @@ -0,0 +1,3 @@ +# Widgets + +A reference to the builtin [widgets](../guide/widgets.md). diff --git a/mkdocs.yml b/mkdocs.yml index 58f29d109..fe215570e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 diff --git a/poetry.lock b/poetry.lock index 1871dd8ed..c6c1d2d27 100644 --- a/poetry.lock +++ b/poetry.lock @@ -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