From 938da4e725fc278666fabb0bb8610231c681dc73 Mon Sep 17 00:00:00 2001 From: JoeZiminski Date: Tue, 14 May 2024 23:09:19 +0100 Subject: [PATCH] Fix build warnings. --- docs/source/pages/community/contributing.md | 6 +++--- docs/source/pages/how_tos/make-a-new-project.md | 2 -- docs/source/pages/tutorials/getting_started.md | 4 ++-- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/source/pages/community/contributing.md b/docs/source/pages/community/contributing.md index 3f660f40..20f933fe 100644 --- a/docs/source/pages/community/contributing.md +++ b/docs/source/pages/community/contributing.md @@ -5,8 +5,8 @@ If you're unsure about any part of the contributing process and have any questions, please get in touch through our [Zulip chat](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle). Otherwise, please dive right in to contributing by -[creating a developlemt environment](creating-a-development-environment) -and [opening a pull request](pull-requests). +[creating a developlemt environment](#creating-a-development-environment) +and [opening a pull request](#pull-requests). The core development team will support you in contributing code, irrespective of your experience! @@ -116,7 +116,7 @@ skip pre-commit checks, and ask for help in your PR. For docstrings, we adhere to the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) style. Make sure to provide docstrings for all public functions, classes, and methods. -## To improve the documentation +## Contributing documentation It is very important the documentation for **datashuttle** is clear accurate and concise. A key principle of **datashuttle** is it should diff --git a/docs/source/pages/how_tos/make-a-new-project.md b/docs/source/pages/how_tos/make-a-new-project.md index b4b14185..e0a7f5bb 100644 --- a/docs/source/pages/how_tos/make-a-new-project.md +++ b/docs/source/pages/how_tos/make-a-new-project.md @@ -1,5 +1,3 @@ -(make-a-new-project)= - # How to Make a New Project This guide will cover all you need to know for setting up a new project diff --git a/docs/source/pages/tutorials/getting_started.md b/docs/source/pages/tutorials/getting_started.md index a7fc0f97..e5220a93 100644 --- a/docs/source/pages/tutorials/getting_started.md +++ b/docs/source/pages/tutorials/getting_started.md @@ -80,7 +80,7 @@ We need to set the: **datashuttle** supports connecting to the central storage machine either as a mounted drive or through SHH. \ -See [How to Make a New Project](make-a-new-project) +See [How to Make a New Project](/pages/how_tos/make-a-new-project) for detailed instructions for connecting a mounted drive or by using SSH. @@ -577,7 +577,7 @@ from your **local path**. We will next download data from the **central path** to our now-empty local project. In practice when setting up **datashuttle** on a new machine, you would -again [Make a new project](make-a-new-project). +again [Make a new project](/pages/how_tos/make-a-new-project). ``` We will look at a small subset of possible