From eac39512c137cd0db6387ae8f436dbece39b61ce Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Sun, 27 Aug 2023 21:40:11 +0200 Subject: [PATCH] docs: "Introduction" changed to "Tag Index" for examples --- docs/users_guide/examples/introduction.md | 6 ------ docs/users_guide/examples/tags_index.md | 10 ++++++++++ mkdocs.yml | 4 ++-- 3 files changed, 12 insertions(+), 8 deletions(-) delete mode 100644 docs/users_guide/examples/introduction.md create mode 100644 docs/users_guide/examples/tags_index.md diff --git a/docs/users_guide/examples/introduction.md b/docs/users_guide/examples/introduction.md deleted file mode 100644 index e333619a..00000000 --- a/docs/users_guide/examples/introduction.md +++ /dev/null @@ -1,6 +0,0 @@ -# Introduction - -All usage examples in this chapter are categorized with appropriate tags to simplify navigation and search -of relevant code. - -[TAGS] diff --git a/docs/users_guide/examples/tags_index.md b/docs/users_guide/examples/tags_index.md new file mode 100644 index 00000000..d1224ae1 --- /dev/null +++ b/docs/users_guide/examples/tags_index.md @@ -0,0 +1,10 @@ +# Tags Index + +!!! note + + All usage examples in this chapter are categorized with appropriate tags to simplify navigation and + search of relevant code. You can either read all the examples one-by-one in the order provided by + the documentation authors or, thanks to the tagging system, jump straight to the example that is + the most interesting for you. + +[TAGS] diff --git a/mkdocs.yml b/mkdocs.yml index aa9f0ed6..4ddfeb5a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,7 +53,7 @@ theme: plugins: - search - tags: - tags_file: users_guide/examples/introduction.md + tags_file: users_guide/examples/tags_index.md # Customization extra: @@ -138,7 +138,7 @@ nav: - Interoperability with Other Units Libraries: users_guide/use_cases/interoperability_with_other_units_libraries.md - Extending the Library: users_guide/use_cases/extending_the_library.md - Examples: - - Introduction: users_guide/examples/introduction.md + - Tags Index: users_guide/examples/tags_index.md - hello_units: users_guide/examples/hello_units.md - Library Reference: - Core Library: library_reference/core_library.md