Add parsing of toc from docset.yml (#60)

elastic · Nov 12, 2024 · 2b862bc · 2b862bc
1 parent 75c7ebe
commit 2b862bc
Show file tree

Hide file tree

Showing 21 changed files with 215 additions and 146 deletions.
diff --git a/docs/source/docset.yml b/docs/source/docset.yml
@@ -3,14 +3,30 @@ exclude:
   - '_*.md'
 toc:
   - file: index.md
-  - file: config.md
-  - file: search.md
+  - folder: markup
+  - folder: elastic
     children:
-      - file: search-part2.md
-      - folder: search
-  - folder: my-folder1
-  - folder: my-folder2
+      - file: index.md
+      - folder: observability
+      - folder: reference
+      - folder: semantic-search
+      - folder: search-labs
+        children:
+          - file: index.md
+          - file: chat.md
+            children:
+              - file: chat/req.md
+              - file: chat/rag.md
+          - file: search.md
+            children:
+              - file: search/req.md
+              - file: search/setup.md
+          - file: install.md
+            children:
+              - file: install/cloud.md
+              - file: install/docker.md
+  - folder: nested
     children:
-      - file: subpath/file.md
-      - file: file.md
-      - folder: sub/folder
+      - folder: content
+      - file: index.md
+  - folder: versioning
diff --git a/...semantic-search/snippets/index-mapping.md → ...emantic-search/_snippets/index-mapping.md b/...semantic-search/snippets/index-mapping.md → ...emantic-search/_snippets/index-mapping.md
diff --git a/...tic-search/snippets/inference-endpoint.md → ...ic-search/_snippets/inference-endpoint.md b/...tic-search/snippets/inference-endpoint.md → ...ic-search/_snippets/inference-endpoint.md
diff --git a/docs/source/elastic/semantic-search/amazon-bedrock.md b/docs/source/elastic/semantic-search/amazon-bedrock.md
@@ -38,7 +38,7 @@ The examples in this tutorial use the `amazon.titan-embed-text-v1` model from th
 
 ## Create an inference endpoint
 
-```{include} snippets/inference-endpoint.md
+```{include} _snippets/inference-endpoint.md
 ```
 
 ```{code-block} bash
@@ -67,7 +67,7 @@ PUT _inference/text_embedding/amazon_bedrock_embeddings
 
 ## Create the index mapping
 
-```{include} snippets/index-mapping.md
+```{include} _snippets/index-mapping.md
 ```
 
 ```{code-block} bash

diff --git a/docs/source/elastic/semantic-search/azure-ai-studio.md b/docs/source/elastic/semantic-search/azure-ai-studio.md
@@ -39,7 +39,7 @@ The examples in this tutorial use models available through [Azure AI Studio](htt
 
 ## Create an inference endpoint
 
-```{include} snippets/inference-endpoint.md
+```{include} _snippets/inference-endpoint.md
 ```
 
 ```{code-block} bash
@@ -67,7 +67,7 @@ PUT _inference/text_embedding/azure_ai_studio_embeddings
 
 ## Create the index mapping
 
-```{include} snippets/index-mapping.md
+```{include} _snippets/index-mapping.md
 ```
 
 ```{code-block} bash

diff --git a/docs/source/elastic/semantic-search/azure-openai.md b/docs/source/elastic/semantic-search/azure-openai.md
@@ -39,7 +39,7 @@ The examples in this tutorial use models available through [Azure OpenAI](https:
 
 ## Create an inference endpoint
 
-```{include} snippets/inference-endpoint.md
+```{include} _snippets/inference-endpoint.md
 ```
 
 ```{code-block} bash
@@ -67,7 +67,7 @@ PUT _inference/text_embedding/azure_openai_embeddings
 
 ## Create the index mapping
 
-```{include} snippets/index-mapping.md
+```{include} _snippets/index-mapping.md
 ```
 
 ```{code-block} bash

diff --git a/docs/source/elastic/semantic-search/cohere.md b/docs/source/elastic/semantic-search/cohere.md
@@ -37,7 +37,7 @@ A [Cohere account](https://cohere.com/) is required to use the inference API wit
 
 ## Create an inference endpoint
 
-```{include} snippets/inference-endpoint.md
+```{include} _snippets/inference-endpoint.md
 ```
 
 ```{code-block} bash
@@ -65,7 +65,7 @@ When using this model the recommended similarity measure to use in the dense_vec
 
 ## Create the index mapping
 
-```{include} snippets/index-mapping.md
+```{include} _snippets/index-mapping.md
 ```
 
 ```{code-block} bash

diff --git a/docs/source/elastic/semantic-search/elser.md b/docs/source/elastic/semantic-search/elser.md
@@ -34,7 +34,7 @@ ELSER is a model trained by Elastic. If you have an Elasticsearch deployment, th
 
 ## Create an inference endpoint
 
-```{include} snippets/inference-endpoint.md
+```{include} _snippets/inference-endpoint.md
 ```
 
 ```{code-block} bash
@@ -57,7 +57,7 @@ You don’t need to download and deploy the ELSER model upfront, the API request
 
 ## Create the index mapping
 
-```{include} snippets/index-mapping.md
+```{include} _snippets/index-mapping.md
 ```
 
 ```{code-block} bash

diff --git a/docs/source/markup/snippets/my_snippet.md → docs/source/markup/_snippets/my_snippet.md b/docs/source/markup/snippets/my_snippet.md → docs/source/markup/_snippets/my_snippet.md
diff --git a/docs/source/markup/code.md b/docs/source/markup/code.md
@@ -42,14 +42,6 @@ project:
   subject: MyST Markdown
 ```
 
-```{sidebar}
-This code is very helpful.
-
-It does lots of things.
-
-But it does not sing.
-```
-
 ```{code-block} python
     :caption: Code blocks can also have sidebars.
     :linenos:

diff --git a/docs/source/markup/diagrams.md b/docs/source/markup/diagrams.md
diff --git a/docs/source/markup/file_inclusion.md b/docs/source/markup/file_inclusion.md
@@ -11,5 +11,5 @@ The rest of this page is from a snippet and "{{page_title}}" below is taken from
 
 ## Snippet
 
-```{include} snippets/my_snippet.md
+```{include} _snippets/my_snippet.md
 ```
diff --git a/src/Elastic.Markdown/Elastic.Markdown.csproj b/src/Elastic.Markdown/Elastic.Markdown.csproj
@@ -15,6 +15,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="DotNet.Glob" Version="3.1.3" />
     <PackageReference Include="Markdig" Version="0.37.0"/>
     <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
     <PackageReference Include="RazorSlices" Version="0.8.1" />