Introduce docset.yml (#59)

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

Hide file tree

Showing 28 changed files with 263 additions and 388 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -136,12 +136,12 @@ csharp_style_var_for_built_in_types = true:error
 csharp_style_var_when_type_is_apparent = true:error
 csharp_style_var_elsewhere = true:error
 
-csharp_style_expression_bodied_methods = true:warning
-csharp_style_expression_bodied_constructors = true:warning
-csharp_style_expression_bodied_operators = true:warning
-csharp_style_expression_bodied_properties = true:warning
-csharp_style_expression_bodied_indexers = true:warning
-csharp_style_expression_bodied_accessors = true:warning
+csharp_style_expression_bodied_methods = true:suggestion
+csharp_style_expression_bodied_constructors = true:suggestion
+csharp_style_expression_bodied_operators = true:suggestion
+csharp_style_expression_bodied_properties = true:suggestion
+csharp_style_expression_bodied_indexers = true:suggestion
+csharp_style_expression_bodied_accessors = true:suggestion
 
 # Suggest more modern language features when available
 csharp_style_pattern_matching_over_is_with_cast_check = true:error

diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/docset.yml b/docs/source/docset.yml
@@ -0,0 +1,16 @@
+project: 'doc-builder'
+exclude:
+  - '_*.md'
+toc:
+  - file: index.md
+  - file: config.md
+  - file: search.md
+    children:
+      - file: search-part2.md
+      - folder: search
+  - folder: my-folder1
+  - folder: my-folder2
+    children:
+      - file: subpath/file.md
+      - file: file.md
+      - folder: sub/folder
diff --git a/docs/source/elastic/index.md b/docs/source/elastic/index.md
@@ -10,12 +10,3 @@ Here's what we have so far:
 * [Search Labs Tutorial](search-labs/index.md) — A partial port of the Search Labs Tutorials content currently hosted [here](https://www.elastic.co/search-labs/tutorials).
 * [Automated Settings Reference](reference/index.md) — An example of an automatically automated setting
 * [Observability overview](observability/index.md) — Nothing special, just a bunch of images and text.
-
-```{toctree}
-:hidden:
-
-Tutorial: Semantic search with the inference API <semantic-search/index.md>
-Search Labs <search-labs/index.md>
-Automated Settings <reference/index.md>
-Observability overview <observability/index.md>
-```
diff --git a/docs/source/elastic/reference/index.md b/docs/source/elastic/reference/index.md
@@ -8,11 +8,4 @@ Simply supply a yaml spec and corresponding template file and content will be au
 This section includes one example yaml file and two auto-generated outputs based on that file:
 
 * [example `yaml` file](source.md)
-* [generated output](generated.md)
-
-```{toctree}
-:hidden:
-
-source.md
-generated.md
-```
+* [generated output](generated.md)
diff --git a/docs/source/elastic/search-labs/chat.md b/docs/source/elastic/search-labs/chat.md
@@ -2,13 +2,6 @@
 title: Chatbot Tutorial
 ---
 
-```{toctree}
-:hidden:
-
-chat/req.md
-chat/rag.md
-```
-
 In this tutorial you are going to build a large language model (LLM) chatbot that uses a pattern known as [Retrieval-Augmented Generation (RAG)](https://www.elastic.co/what-is/retrieval-augmented-generation).
 
 <!-- ![Chatbot App Demo](/assets/images/guides/chatbot-app-demo.gif) -->

diff --git a/docs/source/elastic/search-labs/index.md b/docs/source/elastic/search-labs/index.md
@@ -2,15 +2,6 @@
 title: Search Labs Tutorials
 ---
 
-```{toctree}
-:hidden:
-
-install.md
-search.md
-chat.md
-```
-
-
 ## Start here
 
 ````{grid} 3

diff --git a/docs/source/elastic/search-labs/install.md b/docs/source/elastic/search-labs/install.md
@@ -2,13 +2,6 @@
 title: "Install Elasticsearch"
 ---
 
-```{toctree}
-:hidden:
-
-install/cloud.md
-install/docker.md
-```
-
 In this section you will learn about some of the options you have for running Elasticsearch. Most of the tutorials and content on this site will require you to first follow the instructions below for your chosen method of installation.
 
 ## How to run Elasticsearch

diff --git a/docs/source/elastic/search-labs/search.md b/docs/source/elastic/search-labs/search.md
@@ -2,13 +2,6 @@
 title: "Search Tutorial"
 ---
 
-```{toctree}
-:hidden:
-
-search/req.md
-search/setup.md
-```
-
 Welcome!
 
 This hands-on tutorial will teach you how to build a complete search solution using [Elasticsearch](https://www.elastic.co/). In this tutorial you will learn:

diff --git a/docs/source/elastic/semantic-search/index.md b/docs/source/elastic/semantic-search/index.md
@@ -42,13 +42,3 @@ Amazon Bedrock examples use the `amazon.titan-embed-text-v1` model from the [Ama
 ```{tip}
 Not seeing the tutorial? Select a service above to get started.
 ```
-
-```{toctree}
-:hidden:
-
-Amazon Bedrock <amazon-bedrock.md>
-Azure AI Studio <azure-ai-studio.md>
-Azure OpenAI <azure-openai.md>
-Cohere <cohere.md>
-ELSER <elser.md>
-```
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -36,14 +36,3 @@ Hate it? Love it? We want to hear it all. Say hello and leave your thoughts in [
 
 Hosted docs are great and all, but what's the contributor experience like?
 Read the [quick start guide](https://github.com/elastic/markitpy/tree/main), clone the repository, and spin up the docs locally in seconds.
-
-
-```{toctree}
-:caption: Elastic Docs Guide
-:hidden:
-
-elastic/index.md
-markup/index.md
-nested/index.md
-versioning/index.md
-```
diff --git a/docs/source/markup/index.md b/docs/source/markup/index.md
@@ -3,24 +3,3 @@ title: Markup guide
 ---
 
 Here are some samples to show some features that you might want to use in your documentation.
-
-```{toctree}
-:hidden:
-
-admonitions.md
-tables.md
-code.md
-tabs.md
-dropdowns.md
-cards_grids.md
-diagrams.md
-images.md
-sundries.md
-substitutions.md
-file_inclusion.md
-extensions_with_roles_and_directives.md
-yaml_to_markdown.md
-notebook.ipynb
-rst.rst
-rst_in_markdown.md
-```
diff --git a/docs/source/multiversion_conf.py b/docs/source/multiversion_conf.py
diff --git a/docs/source/nested/content/index.md b/docs/source/nested/content/index.md
@@ -4,8 +4,3 @@ title: Content
 
 Welcome to Nested Content.
 
-```{toctree}
-:hidden:
-
-nest-cafe.md
-```
diff --git a/docs/source/nested/index.md b/docs/source/nested/index.md
@@ -3,9 +3,3 @@ title: Nested content
 ---
 
 This bucket is an example of nested content. Head down the tree to see how it works.
-
-```{toctree}
-:hidden:
-
-content/index.md
-```
diff --git a/docs/source/theme_conf.py b/docs/source/theme_conf.py
diff --git a/docs/source/versioning/index.md b/docs/source/versioning/index.md
@@ -9,8 +9,3 @@ Multiversion support
 This file demonstrates versioning support.
 See the `markitpy` readme to learn how to test this content.
 
-```{toctree}
-:hidden:
-
-versioned.md
-```