From 9aa5111b2fb0467e594d9b4f52d1b81c61ed3853 Mon Sep 17 00:00:00 2001 From: Dan Allan Date: Tue, 17 Sep 2024 09:55:12 -0400 Subject: [PATCH] Get headings right --- docs/contributing.md | 20 +++++++++++--------- docs/index.md | 6 +++--- docs/recipes/how-to.md | 7 +++++++ docs/recipes/tutorials.md | 7 +++++++ 4 files changed, 28 insertions(+), 12 deletions(-) create mode 100644 docs/recipes/how-to.md create mode 100644 docs/recipes/tutorials.md diff --git a/docs/contributing.md b/docs/contributing.md index 34875ba..7bc3c9d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -28,10 +28,10 @@ git clone git@github.com:bluesky/bluesky-cookbok ## Overview -Each "recipe" is a directory under `docs/tutorials/` or `docs/how-to/`. It may -contain one or more Markdown (`.md`) files with a mixture of narrative text and -code. Each recipe directory may also contain supporting data files, scripts, -illustrations, solutions to exercises, etc. +Each "recipe" is a directory under `docs/recipes/tutorials/` or +`docs/recipes/how-to/`. It may contain one or more Markdown (`.md`) files with +a mixture of narrative text and code. Each recipe directory may also contain +supporting data files, scripts, illustrations, solutions to exercises, etc. ```none $ tree docs/ @@ -39,11 +39,13 @@ docs/ ├── conf.py ├── contributing.md ├── index.md -├── tutorials -│   ├── getting-started -│   │   ├── hello-bluesky.md -│   ├── flyscanning -│   │   ├── basic-demo.md +├── recipes +│   ├── tutorials +│   │   ├── getting-started +│   │   │   └── hello-bluesky.md +│   │   ├── flyscanning +│   │   │   └── basic-demo.md +│   ├── how-to ... ``` diff --git a/docs/index.md b/docs/index.md index 5504d3f..7291917 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,10 @@ # Bluesky Cookbook ```{toctree} -:maxdepth: 3 +:maxdepth: 1 :glob: -recipes/tutorials/**/* -recipes/how-to/**/* +recipes/tutorials.md +recipes/how-to.md glossary contributing ``` diff --git a/docs/recipes/how-to.md b/docs/recipes/how-to.md new file mode 100644 index 0000000..8eb9abd --- /dev/null +++ b/docs/recipes/how-to.md @@ -0,0 +1,7 @@ +# How-To Guides + +```{toctree} +:maxdepth: 2 +:glob: +how-to/**/* +``` diff --git a/docs/recipes/tutorials.md b/docs/recipes/tutorials.md new file mode 100644 index 0000000..15cc312 --- /dev/null +++ b/docs/recipes/tutorials.md @@ -0,0 +1,7 @@ +# Tutorials + +```{toctree} +:maxdepth: 2 +:glob: +tutorials/**/* +```