Skip to content

doc: improved use of globbing in toctree #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mkbhanda merged 1 commit into from
Sep 9, 2024
Merged

doc: improved use of globbing in toctree #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions deploy/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ Installation Guides
:maxdepth: 1
:glob:

../guide/installation/*/*
../guide/installation/*
../guide/installation/**/*

Authentication and Authorization
********************************
Expand All @@ -35,7 +36,7 @@ Authentication and Authorization
:glob:

/GenAIInfra/authN-authZ/*
/GenAIInfra/authN-authZ/*/*
/GenAIInfra/authN-authZ/**/*

Helm Charts
***********
Expand All @@ -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
*****************
Expand All @@ -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
***********************
Expand All @@ -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
*******
Expand All @@ -85,6 +91,4 @@ Scripts

/GenAIInfra/scripts/README
/GenAIInfra/scripts/*
/GenAIInfra/scripts/*/*
/GenAIInfra/scripts/*/*/*
/GenAIInfra/scripts/*/*/*/*
/GenAIInfra/scripts/**/*
5 changes: 1 addition & 4 deletions eval/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,4 @@ We're building this documentation from content in the

/GenAIEval/README
/GenAIEval/*
/GenAIEval/*/*
/GenAIEval/*/*/*
/GenAIEval/*/*/*/*
/GenAIEval/*/*/*/*/*
/GenAIEval/**/*
54 changes: 14 additions & 40 deletions examples/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ AgentQnA Application
:glob:

/GenAIExamples/AgentQnA/*
/GenAIExamples/AgentQnA/*/*
/GenAIExamples/AgentQnA/**/*

AudioQnA Application
********************
Expand All @@ -43,9 +43,7 @@ AudioQnA Application
:glob:

/GenAIExamples/AudioQnA/*
/GenAIExamples/AudioQnA/*/*
/GenAIExamples/AudioQnA/*/*/*
/GenAIExamples/AudioQnA/*/*/*/*
/GenAIExamples/AudioQnA/**/*

ChatQnA Application
*******************
Expand All @@ -55,9 +53,7 @@ ChatQnA Application
:glob:

/GenAIExamples/ChatQnA/*
/GenAIExamples/ChatQnA/*/*
/GenAIExamples/ChatQnA/*/*/*
/GenAIExamples/ChatQnA/*/*/*/*
/GenAIExamples/ChatQnA/**/*

Code Generation Application
***************************
Expand All @@ -67,10 +63,7 @@ Code Generation Application
:glob:

/GenAIExamples/CodeGen/*
/GenAIExamples/CodeGen/*/*
/GenAIExamples/CodeGen/*/*/*
/GenAIExamples/CodeGen/*/*/*/*
/GenAIExamples/CodeGen/*/*/*/*/*
/GenAIExamples/CodeGen/**/*

Code Translation Application
****************************
Expand All @@ -80,9 +73,7 @@ Code Translation Application
:glob:

/GenAIExamples/CodeTrans/*
/GenAIExamples/CodeTrans/*/*
/GenAIExamples/CodeTrans/*/*/*
/GenAIExamples/CodeTrans/*/*/*/*
/GenAIExamples/CodeTrans/**/*

Document Index Retriever Application
************************************
Expand All @@ -92,7 +83,7 @@ Document Index Retriever Application
:glob:

/GenAIExamples/DocIndexRetriever/*
/GenAIExamples/DocIndexRetriever/*/*
/GenAIExamples/DocIndexRetriever/**/*


Document Summarization Application
Expand All @@ -103,10 +94,7 @@ Document Summarization Application
:glob:

/GenAIExamples/DocSum/*
/GenAIExamples/DocSum/*/*
/GenAIExamples/DocSum/*/*/*
/GenAIExamples/DocSum/*/*/*/*
/GenAIExamples/DocSum/*/*/*/*/*
/GenAIExamples/DocSum/**/*

FaqGen Application
*********************
Expand All @@ -116,10 +104,7 @@ FaqGen Application
:glob:

/GenAIExamples/FaqGen/*
/GenAIExamples/FaqGen/*/*
/GenAIExamples/FaqGen/*/*/*
/GenAIExamples/FaqGen/*/*/*/*
/GenAIExamples/FaqGen/*/*/*/*/*
/GenAIExamples/FaqGen/**/*

Instruction Tuning Application
******************************
Expand All @@ -129,8 +114,7 @@ Instruction Tuning Application
:glob:

/GenAIExamples/InstructionTuning/*
/GenAIExamples/InstructionTuning/*/*
/GenAIExamples/InstructionTuning/*/*/*
/GenAIExamples/InstructionTuning/**/*


ProductivitySuite Application
Expand All @@ -141,10 +125,7 @@ ProductivitySuite Application
:glob:

/GenAIExamples/ProductivitySuite/*
/GenAIExamples/ProductivitySuite/*/*
/GenAIExamples/ProductivitySuite/*/*/*
/GenAIExamples/ProductivitySuite/*/*/*/*
/GenAIExamples/ProductivitySuite/*/*/*/*/*
/GenAIExamples/ProductivitySuite/**/*

Rerank Model Fine Tuning
************************
Expand All @@ -154,8 +135,7 @@ Rerank Model Fine Tuning
:glob:

/GenAIExamples/RerankFinetuning/*
/GenAIExamples/RerankFinetuning/*/*
/GenAIExamples/RerankFinetuning/*/*/*
/GenAIExamples/RerankFinetuning/**/*


SearchQnA Application
Expand All @@ -166,9 +146,7 @@ SearchQnA Application
:glob:

/GenAIExamples/SearchQnA/*
/GenAIExamples/SearchQnA/*/*
/GenAIExamples/SearchQnA/*/*/*
/GenAIExamples/SearchQnA/*/*/*/*
/GenAIExamples/SearchQnA/**/*

Translation Application
***********************
Expand All @@ -178,9 +156,7 @@ Translation Application
:glob:

/GenAIExamples/Translation/*
/GenAIExamples/Translation/*/*
/GenAIExamples/Translation/*/*/*
/GenAIExamples/Translation/*/*/*/*
/GenAIExamples/Translation/**/*

VisualQnA Application
*********************
Expand All @@ -190,6 +166,4 @@ VisualQnA Application
:glob:

/GenAIExamples/VisualQnA/*
/GenAIExamples/VisualQnA/*/*
/GenAIExamples/VisualQnA/*/*/*
/GenAIExamples/VisualQnA/*/*/*/*
/GenAIExamples/VisualQnA/**/*
7 changes: 1 addition & 6 deletions microservices/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,5 @@ We're building this microservices documentation from content in the

/GenAIComps/README
/GenAIComps/*
/GenAIComps/*/*
/GenAIComps/*/*/*
/GenAIComps/*/*/*/*
/GenAIComps/*/*/*/*/*
/GenAIComps/*/*/*/*/*/*
/GenAIComps/*/*/*/*/*/*/*
/GenAIComps/**/*