new arch

CAVEconnectome · Jan 19, 2024 · af26900 · af26900
1 parent 73e14ab
commit af26900
Show file tree

Hide file tree

Showing 29 changed files with 98 additions and 61 deletions.
diff --git a/changelog.md b/changelog.md
@@ -1,6 +1,4 @@
----
-title: Changelog
----
+# Changelog
 
 5.1.0
 ----

diff --git a/docs/client_api/annotation.md b/docs/client_api/annotation.md
@@ -16,10 +16,5 @@ Extended documentation for all versions of the annotation client can be found
 
 ::: caveclient.annotationengine.AnnotationClientV2
     options:
-        show_root_heading: false
         heading_level: 2
-        docstring_style: numpy
-        inherited_members: true
         show_bases: false
-        show_root_toc_entry: false
-        members_order: source
diff --git a/docs/client_api/chunkedgraph.md b/docs/client_api/chunkedgraph.md
@@ -1,4 +1,6 @@
-# client.chunkedgraph
+---
+title: client.chunkedgraph
+---
 
 Note: the functionality described here will be accurate if the datastack you are using
 is using the most up-to-date version of the chunkedgraph engine. If something seems
@@ -14,10 +16,5 @@ Extended documentation for all versions of the chunkedgraph client can be found
 
 ::: caveclient.chunkedgraph.ChunkedGraphClientV1
     options:
-        show_root_heading: false
         heading_level: 2
-        docstring_style: numpy
-        inherited_members: true
         show_bases: false
-        show_root_toc_entry: false
-        members_order: source
diff --git a/docs/client_api/overview.md → docs/client_api/index.md b/docs/client_api/overview.md → docs/client_api/index.md
@@ -1,4 +1,6 @@
-# Overview
+---
+title: Overview
+---
 
 The most common method of interacting with the CAVE Framework is by instantiating a
 client (`caveclient.CAVEclient`) and then using that client to interact with various

diff --git a/docs/client_api/l2cache.md b/docs/client_api/l2cache.md
@@ -1,4 +1,6 @@
-# client.l2cache
+---
+title: client.l2cache
+---
 
 Note: the functionality described here will be accurate if the datastack you are using
 is using the most up-to-date version of the level-2 cache. If something seems
@@ -13,10 +15,5 @@ Extended documentation for all versions of the level-2 cache client can be found
 
 ::: caveclient.l2cache.L2CacheClientLegacy
     options:
-        show_root_heading: false
         heading_level: 2
-        docstring_style: numpy
-        inherited_members: true
         show_bases: false
-        show_root_toc_entry: false
-        members_order: source
diff --git a/docs/client_api/materialize.md b/docs/client_api/materialize.md
@@ -1,4 +1,6 @@
-# client.materialize
+---
+title: client.materialize
+---
 
 Note: the functionality described here will be accurate if the datastack you are using
 is using the most up-to-date version of the materialization engine. If something seems
@@ -14,10 +16,5 @@ Extended documentation for all versions of the materialization client can be fou
 
 ::: caveclient.materializationengine.MaterializatonClientV3
     options:
-        show_root_heading: false
         heading_level: 2
-        docstring_style: numpy
-        inherited_members: true
         show_bases: false
-        show_root_toc_entry: false
-        members_order: source
diff --git a/docs/client_api/state.md b/docs/client_api/state.md
@@ -1,4 +1,6 @@
-# client.state
+---
+title: client.state
+---
 
 Note: the functionality described here will be accurate if the datastack you are using
 is using the most up-to-date version of the state engine. If something seems
@@ -14,10 +16,5 @@ Extended documentation for all versions of the state client can be found
 
 ::: caveclient.jsonservice.JSONServiceV1
     options:
-        show_root_heading: false
         heading_level: 2
-        docstring_style: numpy
-        inherited_members: true
         show_bases: false
-        show_root_toc_entry: false
-        members_order: source
diff --git a/docs/extended_api/annotation.md b/docs/extended_api/annotation.md
diff --git a/docs/extended_api/annotation_schemas.md b/docs/extended_api/annotation_schemas.md
diff --git a/docs/extended_api/annotationengine.md b/docs/extended_api/annotationengine.md
@@ -0,0 +1,5 @@
+---
+title: annotationengine
+---
+
+::: caveclient.annotationengine
diff --git a/docs/extended_api/auth.md b/docs/extended_api/auth.md
@@ -1 +1,5 @@
-::: caveclient.auth
+---
+title: auth
+---
+
+::: caveclient.auth
diff --git a/docs/extended_api/base.md b/docs/extended_api/base.md
@@ -1 +1,5 @@
+---
+title: base
+---
+
 ::: caveclient.base
diff --git a/docs/extended_api/chunkedgraph.md b/docs/extended_api/chunkedgraph.md
@@ -1 +1,5 @@
+---
+title: chunkedgraph
+---
+
 ::: caveclient.chunkedgraph
diff --git a/docs/extended_api/datastack_lookup.md b/docs/extended_api/datastack_lookup.md
@@ -0,0 +1,5 @@
+---
+title: datastack_lookup
+---
+
+::: caveclient.datastack_lookup
diff --git a/docs/extended_api/emannotationschemas.md b/docs/extended_api/emannotationschemas.md
@@ -0,0 +1,5 @@
+---
+title: emannotationschemas
+---
+
+::: caveclient.emannotationschemas
diff --git a/docs/extended_api/endpoints.md b/docs/extended_api/endpoints.md
diff --git a/docs/extended_api/format_utils.md b/docs/extended_api/format_utils.md
diff --git a/docs/extended_api/framework.md b/docs/extended_api/framework.md
@@ -1 +1,5 @@
+---
+title: framework
+---
+
 ::: caveclient.frameworkclient
diff --git a/docs/extended_api/index.md b/docs/extended_api/index.md
@@ -0,0 +1,7 @@
+---
+title: Extended API documentation
+---
+
+This page contains extended documentation for the entire CAVEclient API. This includes
+versions of the API that may not be the latest version, but may still be in use by your
+particular datastack.
diff --git a/docs/extended_api/info.md b/docs/extended_api/info.md
diff --git a/docs/extended_api/infoservice.md b/docs/extended_api/infoservice.md
@@ -0,0 +1,5 @@
+---
+title: infoservice
+---
+
+::: caveclient.infoservice
diff --git a/docs/extended_api/json.md b/docs/extended_api/json.md
diff --git a/docs/extended_api/jsonservice.md b/docs/extended_api/jsonservice.md
@@ -0,0 +1,5 @@
+---
+title: jsonservice
+---
+
+::: caveclient.jsonservice
diff --git a/docs/extended_api/l2_cache.md b/docs/extended_api/l2_cache.md
diff --git a/docs/extended_api/l2cache.md b/docs/extended_api/l2cache.md
@@ -0,0 +1,5 @@
+---
+title: l2cache
+---
+
+::: caveclient.l2cache
diff --git a/docs/extended_api/materialization.md b/docs/extended_api/materialization.md
@@ -1 +1,5 @@
+---
+title: materializationengine
+---
+
 ::: caveclient.materializationengine
diff --git a/docs/extended_api/session_config.md b/docs/extended_api/session_config.md
@@ -1 +1,5 @@
-::: caveclient.session_config
+---
+title: session_config
+---
+
+::: caveclient.session_config
diff --git a/docs/tutorials/intro.md → docs/tutorials/index.md b/docs/tutorials/intro.md → docs/tutorials/index.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -3,12 +3,11 @@ site_url: https://bdpedigo.github.io/CAVEclient/
 repo_url: https://github.com/bdpedigo/CAVEclient/
 repo_name: bdpedigo/CAVEclient
 edit_uri: edit/main/docs/
-#strict: true
 nav:
   - Home: index.md
   - Installation: installation.md
   - Tutorial:
-    - tutorials/intro.md
+    - tutorials/index.md
     - tutorials/framework.md
     - tutorials/authentication.md
     - tutorials/annotation.md
@@ -20,26 +19,26 @@ nav:
     - tutorials/materialization.md
   - Glossary: glossary.md
   - Client API: 
-    - client_api/overview.md
+    - client_api/index.md
     - client_api/annotation.md
     - client_api/chunkedgraph.md
     - client_api/l2cache.md
     - client_api/materialize.md
     - client_api/state.md
   - Extended API:
-    - Annotation: extended_api/annotation.md
-    - Auth: extended_api/auth.md
-    - Base: extended_api/base.md
-    - Chunkedgraph: extended_api/chunkedgraph.md
-    - Annotation Schemas: extended_api/annotation_schemas.md
-    - Endpoints: extended_api/endpoints.md
-    - Format Utils: extended_api/format_utils.md
-    - Framework: extended_api/framework.md
-    - Info: extended_api/info.md
-    - JSON: extended_api/json.md
-    - L2 Cache: extended_api/l2_cache.md
-    - Materialization: extended_api/materialization.md
-    - Session Config: extended_api/session_config.md
+    - extended_api/index.md
+    - extended_api/annotationengine.md
+    - extended_api/auth.md
+    - extended_api/base.md
+    - extended_api/chunkedgraph.md
+    - extended_api/datastack_lookup.md
+    - extended_api/emannotationschemas.md
+    - extended_api/framework.md
+    - extended_api/infoservice.md
+    - extended_api/jsonservice.md
+    - extended_api/l2cache.md
+    - extended_api/materialization.md
+    - extended_api/session_config.md
   - Contributing: contributing.md
   - Changelog: changelog.md
 theme:
@@ -53,7 +52,7 @@ theme:
   icon:
     repo: fontawesome/brands/github
   features:
-    - navigation.indexes
+    # - navigation.indexes
     - navigation.instant
     # - navigation.path
     - navigation.prune
@@ -108,7 +107,8 @@ plugins:
               ignore_init_summary: false
             merge_init_into_class: true
             allow_section_blank_line: false
-            show_root_heading: true
+            show_root_heading: false
+            show_root_toc_entry: false
             show_object_full_path: false
             show_symbol_type_heading: false # whether to show "meth/func/etc" in the page
             show_symbol_type_toc: false # whether to show "meth/func/etc" in the toc
@@ -123,7 +123,7 @@ plugins:
             separate_signature: false
             show_signature_annotations: false
             unwrap_annotated: false # https://mkdocstrings.github.io/python/usage/configuration/signatures/#unwrap_annotated
-            heading_level: 1
+            heading_level: 2
             inherited_members: true
   - macros
   - autorefs