From d76dd66118437db9a0323f1779de6505bdd0f660 Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Sun, 6 Nov 2022 16:11:41 +0000 Subject: [PATCH] fix api index --- docs/api/index.md | 6 ++++-- mkdocs.yml | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/api/index.md b/docs/api/index.md index 8e129acd1..c809557d8 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,3 +1,5 @@ -# Reference +# API -A reference to the Textual public APIs. +This is a API-level reference to the Textual API. See the links on the left (or in the burger menu) for each module, where you can drill down to a class or method. + +If you are new to Textual, you may want to read the [tutorial](./../tutorial.md) or [guide](../guide/index.md) first. diff --git a/mkdocs.yml b/mkdocs.yml index 22f467a7b..6546c24dc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -98,6 +98,7 @@ nav: - "widgets/static.md" - "widgets/tree_control.md" - API: + - "api/index.md" - "api/app.md" - "api/button.md" - "api/color.md" @@ -107,7 +108,6 @@ nav: - "api/footer.md" - "api/geometry.md" - "api/header.md" - - "api/index.md" - "api/message_pump.md" - "api/message.md" - "api/pilot.md"