experimental - nested pages for User Api

asdf-format · Jan 30, 2025 · 9b9b963 · 9b9b963
1 parent ba4a59d
commit 9b9b963
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 9 deletions.
diff --git a/docs/asdf/user_api/asdf_config.rst b/docs/asdf/user_api/asdf_config.rst
@@ -0,0 +1,7 @@
+******************
+asdf.config Module
+******************
+
+.. currentmodule:: asdf
+
+.. automodapi:: asdf.config
diff --git a/docs/asdf/user_api.rst → docs/asdf/user_api/asdf_package.rst b/docs/asdf/user_api.rst → docs/asdf/user_api/asdf_package.rst
@@ -1,16 +1,12 @@
-.. _user_api:
+************
+asdf Package
+************
 
-********
-User API
-********
+.. currentmodule:: asdf
 
 .. automodapi:: asdf
     :include-all-objects:
     :inherited-members:
     :no-inheritance-diagram:
     :skip: ValidationError
     :skip: Stream
-
-.. automodapi:: asdf.search
-
-.. automodapi:: asdf.config
diff --git a/docs/asdf/user_api/asdf_search.rst b/docs/asdf/user_api/asdf_search.rst
@@ -0,0 +1,7 @@
+******************
+asdf.search Module
+******************
+
+.. currentmodule:: asdf
+
+.. automodapi:: asdf.search
diff --git a/docs/asdf/user_api/index.rst b/docs/asdf/user_api/index.rst
@@ -0,0 +1,17 @@
+.. _user_api:
+
+********
+User API
+********
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    asdf_package.rst
+    asdf_search.rst
+    asdf_config.rst
+
+* :doc:`asdf Package <asdf_package>`
+* :doc:`asdf.search Module <asdf_search>`
+* :doc:`asdf.config Module <asdf_config>`
diff --git a/docs/index.rst b/docs/index.rst
@@ -67,7 +67,7 @@ API Documentation
 .. toctree::
   :maxdepth: 1
 
-  asdf/user_api
+  asdf/user_api/index
   asdf/developer_api
 
 Developer Overview