doc: improved use of globbing in toctree (#99)

* use improved globbing pattern to collect markdown docs in the repos * add GenAIInfra/proxy docs to deploy section (was in #96) Signed-off-by: David B. Kinder <[email protected]> Signed-off-by: srinarayan-srikanthan <[email protected]>
opea-project · Sep 9, 2024 · 32ccce5 · 32ccce5
1 parent 65f79ed
commit 32ccce5
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 64 deletions.
diff --git a/deploy/index.rst b/deploy/index.rst
@@ -25,7 +25,8 @@ Installation Guides
    :maxdepth: 1
    :glob:
 
-   ../guide/installation/*/*
+   ../guide/installation/*
+   ../guide/installation/**/*
 
 Authentication and Authorization
 ********************************
@@ -35,7 +36,7 @@ Authentication and Authorization
    :glob:
 
    /GenAIInfra/authN-authZ/*
-   /GenAIInfra/authN-authZ/*/*
+   /GenAIInfra/authN-authZ/**/*
 
 Helm Charts
 ***********
@@ -46,9 +47,7 @@ Helm Charts
 
    /GenAIInfra/helm-charts/README
    /GenAIInfra/helm-charts/*
-   /GenAIInfra/helm-charts/*/*
-   /GenAIInfra/helm-charts/*/*/*
-   /GenAIInfra/helm-charts/*/*/*/*
+   /GenAIInfra/helm-charts/**/*
 
 Kubernetes Addons
 *****************
@@ -59,9 +58,7 @@ Kubernetes Addons
 
    /GenAIInfra/kubernetes-addons/README
    /GenAIInfra/kubernetes-addons/*
-   /GenAIInfra/kubernetes-addons/*/*
-   /GenAIInfra/kubernetes-addons/*/*/*
-   /GenAIInfra/kubernetes-addons/*/*/*/*
+   /GenAIInfra/kubernetes-addons/**/*
 
 Microservices Connector
 ***********************
@@ -72,9 +69,18 @@ Microservices Connector
 
    /GenAIInfra/microservices-connector/README
    /GenAIInfra/microservices-connector/*
-   /GenAIInfra/microservices-connector/*/*
-   /GenAIInfra/microservices-connector/*/*/*
-   /GenAIInfra/microservices-connector/*/*/*/*
+   /GenAIInfra/microservices-connector/**/*
+
+Pipeline Proxy
+**************
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   /GenAIInfra/proxy/README
+   /GenAIInfra/proxy/*
+   /GenAIInfra/proxy/**/*
 
 Scripts
 *******
@@ -85,6 +91,4 @@ Scripts
 
    /GenAIInfra/scripts/README
    /GenAIInfra/scripts/*
-   /GenAIInfra/scripts/*/*
-   /GenAIInfra/scripts/*/*/*
-   /GenAIInfra/scripts/*/*/*/*
+   /GenAIInfra/scripts/**/*
diff --git a/eval/index.rst b/eval/index.rst
@@ -14,7 +14,4 @@ We're building this documentation from content in the
 
    /GenAIEval/README
    /GenAIEval/*
-   /GenAIEval/*/*
-   /GenAIEval/*/*/*
-   /GenAIEval/*/*/*/*
-   /GenAIEval/*/*/*/*/*
+   /GenAIEval/**/*
diff --git a/examples/index.rst b/examples/index.rst
@@ -33,7 +33,7 @@ AgentQnA Application
    :glob:
 
    /GenAIExamples/AgentQnA/*
-   /GenAIExamples/AgentQnA/*/*
+   /GenAIExamples/AgentQnA/**/*
 
 AudioQnA Application
 ********************
@@ -43,9 +43,7 @@ AudioQnA Application
    :glob:
 
    /GenAIExamples/AudioQnA/*
-   /GenAIExamples/AudioQnA/*/*
-   /GenAIExamples/AudioQnA/*/*/*
-   /GenAIExamples/AudioQnA/*/*/*/*
+   /GenAIExamples/AudioQnA/**/*
 
 ChatQnA Application
 *******************
@@ -55,9 +53,7 @@ ChatQnA Application
    :glob:
 
    /GenAIExamples/ChatQnA/*
-   /GenAIExamples/ChatQnA/*/*
-   /GenAIExamples/ChatQnA/*/*/*
-   /GenAIExamples/ChatQnA/*/*/*/*
+   /GenAIExamples/ChatQnA/**/*
 
 Code Generation Application
 ***************************
@@ -67,10 +63,7 @@ Code Generation Application
    :glob:
 
    /GenAIExamples/CodeGen/*
-   /GenAIExamples/CodeGen/*/*
-   /GenAIExamples/CodeGen/*/*/*
-   /GenAIExamples/CodeGen/*/*/*/*
-   /GenAIExamples/CodeGen/*/*/*/*/*
+   /GenAIExamples/CodeGen/**/*
 
 Code Translation Application
 ****************************
@@ -80,9 +73,7 @@ Code Translation Application
    :glob:
 
    /GenAIExamples/CodeTrans/*
-   /GenAIExamples/CodeTrans/*/*
-   /GenAIExamples/CodeTrans/*/*/*
-   /GenAIExamples/CodeTrans/*/*/*/*
+   /GenAIExamples/CodeTrans/**/*
 
 Document Index Retriever Application
 ************************************
@@ -92,7 +83,7 @@ Document Index Retriever Application
    :glob:
 
    /GenAIExamples/DocIndexRetriever/*
-   /GenAIExamples/DocIndexRetriever/*/*
+   /GenAIExamples/DocIndexRetriever/**/*
 
 
 Document Summarization Application
@@ -103,10 +94,7 @@ Document Summarization Application
    :glob:
 
    /GenAIExamples/DocSum/*
-   /GenAIExamples/DocSum/*/*
-   /GenAIExamples/DocSum/*/*/*
-   /GenAIExamples/DocSum/*/*/*/*
-   /GenAIExamples/DocSum/*/*/*/*/*
+   /GenAIExamples/DocSum/**/*
 
 FaqGen Application
 *********************
@@ -116,10 +104,7 @@ FaqGen Application
    :glob:
 
    /GenAIExamples/FaqGen/*
-   /GenAIExamples/FaqGen/*/*
-   /GenAIExamples/FaqGen/*/*/*
-   /GenAIExamples/FaqGen/*/*/*/*
-   /GenAIExamples/FaqGen/*/*/*/*/*
+   /GenAIExamples/FaqGen/**/*
 
 Instruction Tuning Application
 ******************************
@@ -129,8 +114,7 @@ Instruction Tuning Application
    :glob:
 
    /GenAIExamples/InstructionTuning/*
-   /GenAIExamples/InstructionTuning/*/*
-   /GenAIExamples/InstructionTuning/*/*/*
+   /GenAIExamples/InstructionTuning/**/*
 
 
 ProductivitySuite Application
@@ -141,10 +125,7 @@ ProductivitySuite Application
    :glob:
 
    /GenAIExamples/ProductivitySuite/*
-   /GenAIExamples/ProductivitySuite/*/*
-   /GenAIExamples/ProductivitySuite/*/*/*
-   /GenAIExamples/ProductivitySuite/*/*/*/*
-   /GenAIExamples/ProductivitySuite/*/*/*/*/*
+   /GenAIExamples/ProductivitySuite/**/*
 
 Rerank Model Fine Tuning
 ************************
@@ -154,8 +135,7 @@ Rerank Model Fine Tuning
    :glob:
 
    /GenAIExamples/RerankFinetuning/*
-   /GenAIExamples/RerankFinetuning/*/*
-   /GenAIExamples/RerankFinetuning/*/*/*
+   /GenAIExamples/RerankFinetuning/**/*
 
 
 SearchQnA Application
@@ -166,9 +146,7 @@ SearchQnA Application
    :glob:
 
    /GenAIExamples/SearchQnA/*
-   /GenAIExamples/SearchQnA/*/*
-   /GenAIExamples/SearchQnA/*/*/*
-   /GenAIExamples/SearchQnA/*/*/*/*
+   /GenAIExamples/SearchQnA/**/*
 
 Translation Application
 ***********************
@@ -178,9 +156,7 @@ Translation Application
    :glob:
 
    /GenAIExamples/Translation/*
-   /GenAIExamples/Translation/*/*
-   /GenAIExamples/Translation/*/*/*
-   /GenAIExamples/Translation/*/*/*/*
+   /GenAIExamples/Translation/**/*
 
 VisualQnA Application
 *********************
@@ -190,6 +166,4 @@ VisualQnA Application
    :glob:
 
    /GenAIExamples/VisualQnA/*
-   /GenAIExamples/VisualQnA/*/*
-   /GenAIExamples/VisualQnA/*/*/*
-   /GenAIExamples/VisualQnA/*/*/*/*
+   /GenAIExamples/VisualQnA/**/*
diff --git a/microservices/index.rst b/microservices/index.rst
@@ -19,10 +19,5 @@ We're building this microservices documentation from content in the
 
    /GenAIComps/README
    /GenAIComps/*
-   /GenAIComps/*/*
-   /GenAIComps/*/*/*
-   /GenAIComps/*/*/*/*
-   /GenAIComps/*/*/*/*/*
-   /GenAIComps/*/*/*/*/*/*
-   /GenAIComps/*/*/*/*/*/*/*
+   /GenAIComps/**/*