From 6c673ce662c9242015054b4a15f9ff56c6f48055 Mon Sep 17 00:00:00 2001 From: Jonathan Aldous <168206837+JA-met@users.noreply.github.com> Date: Thu, 30 Jul 2026 09:39:35 +0100 Subject: [PATCH 1/5] Link fix in user_guide.md Added forward slashes to paths --- docs/source/user_guide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md index 5a8d294..ce2af8b 100644 --- a/docs/source/user_guide.md +++ b/docs/source/user_guide.md @@ -12,9 +12,9 @@ forecasting and verification. This user guide includes three main sections: -* [Initial set_up](set_up) -* [Running the toolkit](run) -* [Developing the toolkit](devel) +* [Initial set_up](/set_up) +* [Running the toolkit](/run) +* [Developing the toolkit](/devel) This user guide contains instructions on how to get started with the package using the currently available functions. The code is @@ -40,7 +40,7 @@ The goal is that the user does not need to be experienced in coding to use the OSOP toolkit at a basic level. Users more advanced in coding may find that they can edit further down in the software to get more highly specific use cases. As outlined in the section -[development](devel), we encourage you to share your results with the +[development](/devel), we encourage you to share your results with the community by submitting a pull request on the main repository so that others can benefit from the same changes. Similarly, if a user feels they have identified a need that is not available within the product @@ -53,4 +53,4 @@ future changes to the toolkit by the producers may affect this guidance document. It is recommended to regularly update the toolkit locally to ensure that it is in sync with the main remote branch and includes all recent changes. Guidance on how to do this can be found -in the section [Development](devel). +in the section [Development](/devel). From 5f4a8cdecaed98d310b00c1e1cc93b28470a349d Mon Sep 17 00:00:00 2001 From: Jonathan Aldous <168206837+JA-met@users.noreply.github.com> Date: Thu, 30 Jul 2026 16:54:36 +0100 Subject: [PATCH 2/5] Update user_guide.md with .md suffix Test solution --- docs/source/user_guide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md index ce2af8b..2c42d6f 100644 --- a/docs/source/user_guide.md +++ b/docs/source/user_guide.md @@ -12,9 +12,9 @@ forecasting and verification. This user guide includes three main sections: -* [Initial set_up](/set_up) -* [Running the toolkit](/run) -* [Developing the toolkit](/devel) +* [Initial set_up](/set_up.md) +* [Running the toolkit](/run.md) +* [Developing the toolkit](/devel.md) This user guide contains instructions on how to get started with the package using the currently available functions. The code is @@ -40,7 +40,7 @@ The goal is that the user does not need to be experienced in coding to use the OSOP toolkit at a basic level. Users more advanced in coding may find that they can edit further down in the software to get more highly specific use cases. As outlined in the section -[development](/devel), we encourage you to share your results with the +[development](/devel.md), we encourage you to share your results with the community by submitting a pull request on the main repository so that others can benefit from the same changes. Similarly, if a user feels they have identified a need that is not available within the product @@ -53,4 +53,4 @@ future changes to the toolkit by the producers may affect this guidance document. It is recommended to regularly update the toolkit locally to ensure that it is in sync with the main remote branch and includes all recent changes. Guidance on how to do this can be found -in the section [Development](/devel). +in the section [Development](/devel.md). From e0464d588e39f2a0fcdfef3151a0a39a97ee63db Mon Sep 17 00:00:00 2001 From: Jonathan Aldous <168206837+JA-met@users.noreply.github.com> Date: Thu, 30 Jul 2026 16:57:20 +0100 Subject: [PATCH 3/5] Update user_guide.md --- docs/source/user_guide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md index 2c42d6f..cf4ddbd 100644 --- a/docs/source/user_guide.md +++ b/docs/source/user_guide.md @@ -12,9 +12,9 @@ forecasting and verification. This user guide includes three main sections: -* [Initial set_up](/set_up.md) -* [Running the toolkit](/run.md) -* [Developing the toolkit](/devel.md) +* [Initial set_up](docs/source/set_up.md) +* [Running the toolkit](docs/source/run.md) +* [Developing the toolkit](docs/source/devel.md) This user guide contains instructions on how to get started with the package using the currently available functions. The code is @@ -40,7 +40,7 @@ The goal is that the user does not need to be experienced in coding to use the OSOP toolkit at a basic level. Users more advanced in coding may find that they can edit further down in the software to get more highly specific use cases. As outlined in the section -[development](/devel.md), we encourage you to share your results with the +[development](docs/source/devel.md), we encourage you to share your results with the community by submitting a pull request on the main repository so that others can benefit from the same changes. Similarly, if a user feels they have identified a need that is not available within the product @@ -53,4 +53,4 @@ future changes to the toolkit by the producers may affect this guidance document. It is recommended to regularly update the toolkit locally to ensure that it is in sync with the main remote branch and includes all recent changes. Guidance on how to do this can be found -in the section [Development](/devel.md). +in the section [Development](docs/source/devel.md). From 9ec7a166edb5fd69a8236f34b1ac8051a0d68240 Mon Sep 17 00:00:00 2001 From: Jonathan Aldous <168206837+JA-met@users.noreply.github.com> Date: Thu, 30 Jul 2026 17:05:28 +0100 Subject: [PATCH 4/5] Update user_guide.md --- docs/source/user_guide.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md index cf4ddbd..2e6e444 100644 --- a/docs/source/user_guide.md +++ b/docs/source/user_guide.md @@ -1,19 +1,11 @@ -# Introduction - -```{eval-rst} -.. toctree:: - :maxdepth: 2 - :caption: Contents: -``` - This document provides guidance on using the Objective Seasonal Outlook Package (OSOP) toolkit for producing seasonal based forecasting and verification. This user guide includes three main sections: -* [Initial set_up](docs/source/set_up.md) -* [Running the toolkit](docs/source/run.md) +* [Initial set_up](set_up) +* [Running the toolkit](run.md) * [Developing the toolkit](docs/source/devel.md) This user guide contains instructions on how to get started with From 6e17f6c40cf2389d33f7e39bf229fb2fbdbd307d Mon Sep 17 00:00:00 2001 From: Jonathan Aldous <168206837+JA-met@users.noreply.github.com> Date: Thu, 30 Jul 2026 17:07:02 +0100 Subject: [PATCH 5/5] Fixed links in user_guide.md Added .md suffixes --- docs/source/user_guide.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/user_guide.md b/docs/source/user_guide.md index 2e6e444..72eb544 100644 --- a/docs/source/user_guide.md +++ b/docs/source/user_guide.md @@ -4,9 +4,9 @@ forecasting and verification. This user guide includes three main sections: -* [Initial set_up](set_up) +* [Initial set_up](set_up.md) * [Running the toolkit](run.md) -* [Developing the toolkit](docs/source/devel.md) +* [Developing the toolkit](devel.md) This user guide contains instructions on how to get started with the package using the currently available functions. The code is @@ -32,7 +32,7 @@ The goal is that the user does not need to be experienced in coding to use the OSOP toolkit at a basic level. Users more advanced in coding may find that they can edit further down in the software to get more highly specific use cases. As outlined in the section -[development](docs/source/devel.md), we encourage you to share your results with the +[development](devel.md), we encourage you to share your results with the community by submitting a pull request on the main repository so that others can benefit from the same changes. Similarly, if a user feels they have identified a need that is not available within the product @@ -45,4 +45,4 @@ future changes to the toolkit by the producers may affect this guidance document. It is recommended to regularly update the toolkit locally to ensure that it is in sync with the main remote branch and includes all recent changes. Guidance on how to do this can be found -in the section [Development](docs/source/devel.md). +in the section [Development](devel.md).