imrpove api docs

2025-12-06 02:15:22 -05:00 · 2021-01-07 15:25:01 -09:00
parent cbb68a7ea8
commit 048114f2f2
16 changed files with 387 additions and 23 deletions
--- a/docs/docs/api/api-examples.md
+++ b/docs/docs/api/api-examples.md
@@ -0,0 +1,5 @@
+# API Examples
+
+TODO
+
+Have Ideas? Submit a PR!
--- a/docs/docs/api/api-intro.md
+++ b/docs/docs/api/api-intro.md
@@ -1,3 +0,0 @@
-# API Introduction
-
-TODO
--- a/docs/docs/api/demo/index.html
+++ b/docs/docs/api/demo/index.html
--- a/docs/docs/html/api.html
+++ b/docs/docs/html/api.html
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -7,7 +7,6 @@ theme:
    logo: material/silverware-variant
  features:
    - navigation.expand
-    - navigation.instant

 markdown_extensions:
  - pymdownx.emoji:
@@ -35,7 +34,8 @@ nav:
      - Backups and Exports: "getting-started/backups-and-exports.md"
      - Recipe Migration: "getting-started/migration-imports.md"
  - API Reference:
-      - Swagger/OpenAPI: "api/api-intro.md"
+      - API Documentation: "api/demo/index.html"
+      - Usage Examples: "api/api-examples.md"
  - Contributors Guide:
      - Non-Code: "contributors/non-coders.md"
      - Developers Guide: