Manual overhaul of API docs (#451)

datalab-org · Sep 13, 2023 · c419c39 · c419c39
1 parent a78ba75
commit c419c39
Show file tree

Hide file tree

Showing 20 changed files with 34 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ in the Department of Chemistry at the University of Cambridge.
 - A simple, intuitive UI for recording sample metadata and relationships with
   other samples (batches, offshoots), alongside synthesis parameters and raw data.
 - Basic analysis and plotting of live and archived data attached to a sample, e.g.,
-  characterisation via XRD or NMR, electrochemical cycling data and images -- see Blocks for a complete list.
+  characterisation via XRD or NMR, electrochemical cycling data and images (see "Data blocks" section for a complete list).
 - Interactive network visualisation of the connections between samples and inventory.
 
 ## Development status

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -41,6 +41,9 @@ markdown_extensions:
   - toc:
       permalink: true
 
+extra_css:
+  - css/reference.css
+
 plugins:
   - mkdocstrings:
       default_handler: python

diff --git a/pydatalab/docs/.pages b/pydatalab/docs/.pages
@@ -2,5 +2,7 @@ nav:
     - index.md
     - INSTALL.md
     - design
-    - 'Model schemas': schemas
-    - api_reference.md
+    - schemas
+    - blocks
+    - rest_api.md
+    - config.md
diff --git a/pydatalab/docs/api_reference.md b/pydatalab/docs/api_reference.md
diff --git a/pydatalab/docs/api_reference/.pages b/pydatalab/docs/api_reference/.pages
diff --git a/pydatalab/docs/blocks/.pages b/pydatalab/docs/blocks/.pages
@@ -0,0 +1 @@
+title: Data blocks
diff --git a/pydatalab/docs/blocks/apps/.pages b/pydatalab/docs/blocks/apps/.pages
@@ -0,0 +1 @@
+title: Applications
diff --git a/pydatalab/docs/blocks/apps/chat.md b/pydatalab/docs/blocks/apps/chat.md
@@ -0,0 +1,2 @@
+title: Whinchat (LLM assistant)
+::: pydatalab.apps.chat
diff --git a/pydatalab/docs/blocks/apps/echem.md b/pydatalab/docs/blocks/apps/echem.md
@@ -0,0 +1,2 @@
+title: Electrochemistry
+::: pydatalab.apps.echem
diff --git a/pydatalab/docs/blocks/apps/eis.md b/pydatalab/docs/blocks/apps/eis.md
@@ -0,0 +1,2 @@
+title: EIS
+::: pydatalab.apps.eis
diff --git a/pydatalab/docs/blocks/apps/nmr.md b/pydatalab/docs/blocks/apps/nmr.md
@@ -0,0 +1,2 @@
+title: NMR
+::: pydatalab.apps.nmr
diff --git a/pydatalab/docs/blocks/apps/raman.md b/pydatalab/docs/blocks/apps/raman.md
@@ -0,0 +1 @@
+::: pydatalab.apps.raman
diff --git a/pydatalab/docs/blocks/apps/tga.md b/pydatalab/docs/blocks/apps/tga.md
@@ -0,0 +1,2 @@
+title: TGA
+::: pydatalab.apps.tga
diff --git a/pydatalab/docs/blocks/apps/xrd.md b/pydatalab/docs/blocks/apps/xrd.md
@@ -0,0 +1,2 @@
+title: XRD
+::: pydatalab.apps.xrd
diff --git a/pydatalab/docs/blocks/base.md b/pydatalab/docs/blocks/base.md
@@ -0,0 +1 @@
+::: pydatalab.blocks.base
diff --git a/pydatalab/docs/blocks/common.md b/pydatalab/docs/blocks/common.md
@@ -0,0 +1 @@
+::: pydatalab.blocks.common
diff --git a/pydatalab/docs/config.md b/pydatalab/docs/config.md
@@ -0,0 +1,2 @@
+title: Server configuration
+::: pydatalab.config
diff --git a/pydatalab/docs/css/reference.css b/pydatalab/docs/css/reference.css
@@ -0,0 +1,3 @@
+.md-grid {
+    max-width: 70rem;
+}
diff --git a/pydatalab/docs/rest_api.md b/pydatalab/docs/rest_api.md
@@ -0,0 +1,3 @@
+# REST API
+
+::: pydatalab.routes.v0_1
diff --git a/pydatalab/docs/schemas/.pages b/pydatalab/docs/schemas/.pages
@@ -1 +1 @@
-title: "Schemas"
+title: "Data models"