Reduce number of build warnings.

neuroinformatics-unit · Apr 10, 2024 · fbdbf46 · fbdbf46
1 parent 2e13d96
commit fbdbf46
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 10 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -77,11 +77,6 @@
 #toc_object_entries_show_parents = "all"
 html_show_sourcelink = False
 
-#html_sidebars = {  this is not working...
-#  "index": [],
-#  "**": [],
-#}
-
 # Ignore links that do not work with github actions link checking
 # https://github.com/neuroinformatics-unit/actions/pull/24#issue-1978966182
 linkcheck_anchors_ignore_for_url = [
@@ -125,6 +120,10 @@
 
 html_favicon = "_static/logo_light.png"
 
+html_sidebars = {
+  "**": []
+}
+
 # Customize the theme
 html_theme_options = {
     "icon_links": [

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -3,7 +3,7 @@
 {.center}
 # **datashuttle**
 
-<p style="text-align: center; font-size: 22px;">The tool to automate neuroscience project folder creation and transfer.</p>
+<p style="text-align: center; font-size: 22px;">The tool to automate neuroscience project folder creation, validation and transfer.</p>
 
 ```{image} _static/datashuttle-overview-light.png
 :alt: My Logo
@@ -40,16 +40,16 @@ Short guides on specific actions.
 :link: pages/api_index
 :link-type: doc
 
-Full Python API reference.
+Full Python reference.
 :::
 ::::
 
-Datashuttle creates and validates projects standardised to the
+**datashuttle** creates and validates projects standardised to the
 [NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev)
 specification.
 
 Dive right into **datashuttle** with our
-[Getting Started Tutorial]((tutorial-getting-started)=)
+[Getting Started Tutorial](tutorial-getting-started)
 or targeted [How-To Guides](how-tos).
 
 Don't hesitate to get in contact through our

diff --git a/docs/source/pages/how_tos.md b/docs/source/pages/how_tos.md
@@ -1,4 +1,5 @@
 :html_theme.sidebar_secondary.remove:
+
 (how-tos)=
 # How To
 
@@ -70,3 +71,19 @@ A handy feature for template subject and session names.
 :::
 
 ::::
+
+```{toctree}
+:maxdepth: 2
+:caption: how to
+:hidden:
+
+how_tos/choose-a-terminal
+how_tos/create-folders
+how_tos/install
+how_tos/make-a-new-project
+how_tos/transfer-data
+how_tos/read-logs
+how_tos/update-configs
+how_tos/use-name-templates
+
+```
diff --git a/docs/source/pages/tutorials.md b/docs/source/pages/tutorials.md
@@ -14,3 +14,11 @@ Walk-through starting a new experiment with **datashuttle**.
 
 :::
 ::::
+
+```{toctree}
+:maxdepth: 2
+:caption: tutorials
+:hidden:
+
+tutorials/getting_started
+```
diff --git a/docs/source/pages/tutorials/getting_started.md b/docs/source/pages/tutorials/getting_started.md
@@ -1,4 +1,5 @@
 (tutorial-getting-started)=
+
 # Getting Started
 
 ## Introduction
@@ -373,7 +374,7 @@ the central storage, set this to `False`.
 ::::
 
 This was a quick overview of the creating folders—see [How to use Name Templates](how-to-use-name-templates)
-and [How to use Create Folder Tags](how-to-create-folders2) for more detail on validation and convenience tags.
+and [How to use Create Folder Tags](how-to-create-folders) for more detail on validation and convenience tags.
 
 ## Exploring folders