docs: improve doc gen (#180)

conduit-dart · Jan 22, 2023 · 8d18f87 · 8d18f87
1 parent fada64f
commit 8d18f87
Show file tree

Hide file tree

Showing 12 changed files with 11 additions and 15 deletions.
diff --git a/melos.yaml b/melos.yaml
@@ -38,7 +38,7 @@ scripts:
     run: melos exec -- "rm -rf '\$MELOS_PACKAGE_PATH/.dart_tool' '\$MELOS_PACKAGE_PATH/pubspec.lock'"
   gen-docs:
     run: |
-      yq -i 'with(.nav[] | select(has("API")); . = {"API": []})' $MELOS_ROOT_PATH/mkdocs.yml && melos exec --ignore "*common*" -- "dart doc && CONF=\$(echo \$MELOS_PACKAGE_PATH/mkdocs.yml | sed -e 's#^$MELOS_ROOT_PATH#!include .#') yq -i 'with(.nav[] | select(has(\"API\")); .[] += {\"\$MELOS_PACKAGE_NAME\" : strenv(CONF)})' $MELOS_ROOT_PATH/mkdocs.yml"
+      melos exec --ignore "*common*" --ignore "fs_test_agent" -- "dart doc"
     select-pacakge:
       no-private: true
   fix:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,7 +12,7 @@ nav:
   - Getting Started: 'getting_started.md'
   - Core Concepts: 'core_concepts.md'
   - Tour: 'tour.md'
-  - API: []
+  - API: '*include ./packages/*/mkdocs.yml'
   - Best Practices: 'best_practices.md'
   - IntelliJ IDEA Templates: 'intellij.md'
   - Tutorial:

diff --git a/packages/cli/mkdocs.yml b/packages/cli/mkdocs.yml
@@ -2,4 +2,4 @@ site_name: conduit
 docs_dir: doc/api
 
 nav: 
-  - API: "index.html"
+  - Docs: "index.html"
diff --git a/packages/codable/mkdocs.yml b/packages/codable/mkdocs.yml
@@ -2,4 +2,4 @@ site_name: conduit_codable
 docs_dir: doc/api
 
 nav: 
-  - API: "index.html"
+  - Docs: "index.html"
diff --git a/packages/config/mkdocs.yml b/packages/config/mkdocs.yml
@@ -1,4 +1,4 @@
 site_name: conduit_config
 docs_dir: doc/api
 nav: 
-  - API: "index.html"
+  - Docs: "index.html"
diff --git a/packages/core/mkdocs.yml b/packages/core/mkdocs.yml
@@ -2,4 +2,4 @@ site_name: conduit_core
 docs_dir: doc/api
 
 nav: 
-  - API: "index.html"
+  - Docs: "index.html"
diff --git a/packages/fs_test_agent/mkdocs.yml b/packages/fs_test_agent/mkdocs.yml
diff --git a/packages/isolate_exec/mkdocs.yml b/packages/isolate_exec/mkdocs.yml
@@ -2,4 +2,4 @@ site_name: conduit_isolate_exec
 docs_dir: doc/api
 
 nav: 
-  - API: "index.html"
+  - Docs: "index.html"
diff --git a/packages/open_api/mkdocs.yml b/packages/open_api/mkdocs.yml
@@ -2,4 +2,4 @@ site_name: conduit_open_api
 docs_dir: doc/api
 
 nav: 
-  - API: "index.html"
+  - Docs: "index.html"
diff --git a/packages/password_hash/mkdocs.yml b/packages/password_hash/mkdocs.yml
@@ -2,4 +2,4 @@ site_name: conduit_password_hash
 docs_dir: doc/api
 
 nav: 
-  - API: "index.html"
+  - Docs: "index.html"
diff --git a/packages/runtime/mkdocs.yml b/packages/runtime/mkdocs.yml
@@ -2,4 +2,4 @@ site_name: conduit_runtime
 docs_dir: doc/api
 
 nav: 
-  - API: "index.html"
+  - Docs: "index.html"
diff --git a/packages/test_harness/mkdocs.yml b/packages/test_harness/mkdocs.yml
@@ -2,4 +2,4 @@ site_name: conduit_test
 docs_dir: doc/api
 
 nav: 
-  - API: "index.html"
+  - Docs: "index.html"