Skip to content

Commit 39a6228

Browse files
committed
Add parsing of toc from docset.yml
This now also emits errors when - files are linked that do not exists - files appear on disk that are not linked. It also parses the TableOfContents as a tree to be used to render the navigation in a follow up PR
1 parent 75c7ebe commit 39a6228

File tree

21 files changed

+215
-146
lines changed

21 files changed

+215
-146
lines changed

docs/source/docset.yml

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,30 @@ exclude:
33
- '_*.md'
44
toc:
55
- file: index.md
6-
- file: config.md
7-
- file: search.md
6+
- folder: markup
7+
- folder: elastic
88
children:
9-
- file: search-part2.md
10-
- folder: search
11-
- folder: my-folder1
12-
- folder: my-folder2
9+
- file: index.md
10+
- folder: observability
11+
- folder: reference
12+
- folder: semantic-search
13+
- folder: search-labs
14+
children:
15+
- file: index.md
16+
- file: chat.md
17+
children:
18+
- file: chat/req.md
19+
- file: chat/rag.md
20+
- file: search.md
21+
children:
22+
- file: search/req.md
23+
- file: search/setup.md
24+
- file: install.md
25+
children:
26+
- file: install/cloud.md
27+
- file: install/docker.md
28+
- folder: nested
1329
children:
14-
- file: subpath/file.md
15-
- file: file.md
16-
- folder: sub/folder
30+
- folder: content
31+
- file: index.md
32+
- folder: versioning
File renamed without changes.
File renamed without changes.

docs/source/elastic/semantic-search/amazon-bedrock.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The examples in this tutorial use the `amazon.titan-embed-text-v1` model from th
3838

3939
## Create an inference endpoint
4040

41-
```{include} snippets/inference-endpoint.md
41+
```{include} _snippets/inference-endpoint.md
4242
```
4343

4444
```{code-block} bash
@@ -67,7 +67,7 @@ PUT _inference/text_embedding/amazon_bedrock_embeddings
6767

6868
## Create the index mapping
6969

70-
```{include} snippets/index-mapping.md
70+
```{include} _snippets/index-mapping.md
7171
```
7272

7373
```{code-block} bash

docs/source/elastic/semantic-search/azure-ai-studio.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The examples in this tutorial use models available through [Azure AI Studio](htt
3939

4040
## Create an inference endpoint
4141

42-
```{include} snippets/inference-endpoint.md
42+
```{include} _snippets/inference-endpoint.md
4343
```
4444

4545
```{code-block} bash
@@ -67,7 +67,7 @@ PUT _inference/text_embedding/azure_ai_studio_embeddings
6767

6868
## Create the index mapping
6969

70-
```{include} snippets/index-mapping.md
70+
```{include} _snippets/index-mapping.md
7171
```
7272

7373
```{code-block} bash

docs/source/elastic/semantic-search/azure-openai.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The examples in this tutorial use models available through [Azure OpenAI](https:
3939

4040
## Create an inference endpoint
4141

42-
```{include} snippets/inference-endpoint.md
42+
```{include} _snippets/inference-endpoint.md
4343
```
4444

4545
```{code-block} bash
@@ -67,7 +67,7 @@ PUT _inference/text_embedding/azure_openai_embeddings
6767

6868
## Create the index mapping
6969

70-
```{include} snippets/index-mapping.md
70+
```{include} _snippets/index-mapping.md
7171
```
7272

7373
```{code-block} bash

docs/source/elastic/semantic-search/cohere.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ A [Cohere account](https://cohere.com/) is required to use the inference API wit
3737

3838
## Create an inference endpoint
3939

40-
```{include} snippets/inference-endpoint.md
40+
```{include} _snippets/inference-endpoint.md
4141
```
4242

4343
```{code-block} bash
@@ -65,7 +65,7 @@ When using this model the recommended similarity measure to use in the dense_vec
6565

6666
## Create the index mapping
6767

68-
```{include} snippets/index-mapping.md
68+
```{include} _snippets/index-mapping.md
6969
```
7070

7171
```{code-block} bash

docs/source/elastic/semantic-search/elser.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ ELSER is a model trained by Elastic. If you have an Elasticsearch deployment, th
3434

3535
## Create an inference endpoint
3636

37-
```{include} snippets/inference-endpoint.md
37+
```{include} _snippets/inference-endpoint.md
3838
```
3939

4040
```{code-block} bash
@@ -57,7 +57,7 @@ You don’t need to download and deploy the ELSER model upfront, the API request
5757

5858
## Create the index mapping
5959

60-
```{include} snippets/index-mapping.md
60+
```{include} _snippets/index-mapping.md
6161
```
6262

6363
```{code-block} bash
File renamed without changes.

docs/source/markup/code.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,6 @@ project:
4242
subject: MyST Markdown
4343
```
4444
45-
```{sidebar}
46-
This code is very helpful.
47-
48-
It does lots of things.
49-
50-
But it does not sing.
51-
```
52-
5345
```{code-block} python
5446
:caption: Code blocks can also have sidebars.
5547
:linenos:

0 commit comments

Comments
 (0)