From 7f46784a2f25de15da62d7e25342bb5aa2c1bfbc Mon Sep 17 00:00:00 2001 From: "Navid C. Constantinou" Date: Fri, 5 Jul 2024 12:47:07 +1000 Subject: [PATCH] Update README.md after deleting contributed examples (#408) * Update README.md after deleting contributed examples * documented examples -> examples --- README.md | 4 ++-- docs/conf.py | 2 +- docs/{documented_examples.rst => examples.rst} | 0 docs/index.rst | 7 +++---- 4 files changed, 6 insertions(+), 7 deletions(-) rename docs/{documented_examples.rst => examples.rst} (100%) diff --git a/README.md b/README.md index 815b792f..dcefd4e7 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ To make a contribution follow the steps laid out in the [beginner's guide on how https://cosima-recipes.readthedocs.io/en/latest/contributing.html). If they sound intimidating then don't worry! Just raise [an issue](https://github.com/COSIMA/cosima-recipes/issues) explaining briefly what the contribution you want to make is and we'll help out with the process! -## Repository contents +## Contents ### [Tutorials](https://cosima-recipes.readthedocs.io/en/latest/tutorials.html) @@ -26,7 +26,7 @@ The notebook `ACCESS-NRI_Intake_Catalog.ipynb` outlines the basic philosophy of Don't miss out the tutorial about using `cosima-cookbook`'s `explore` submodule to find out about available experiments and variables in a database. (The `explorer` tutorial is better viewed either via nbviewer or by running the jupyter notebook yourself.) -### [Documented Examples](https://cosima-recipes.readthedocs.io/en/latest/documented_examples.html) +### [Examples](https://cosima-recipes.readthedocs.io/en/latest/examples.html) Νotebooks for simple and not-so-simple diagnostics which are well-documented and explained. If you can find an example that suits your purpose, this is the best place to start. ### ACCESS-OM2-GMD-Paper-Figs diff --git a/docs/conf.py b/docs/conf.py index 38eb1922..1f52696c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'COSIMA Recipes' -copyright = '2023, COSIMA' +copyright = '2024, COSIMA' author = 'COSIMA' diff --git a/docs/documented_examples.rst b/docs/examples.rst similarity index 100% rename from docs/documented_examples.rst rename to docs/examples.rst diff --git a/docs/index.rst b/docs/index.rst index 1a6c2a15..b629cd06 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,19 +9,18 @@ COSIMA Recipes documentation Welcome to the COSIMA Recipes documentation! To get started have a look at the tutorials_ and then browse through the -available `documented examples`_ to find something the better suits -your needs! +available examples_ to find something the better suits your needs! .. _tutorials: tutorials.html -.. _documented examples: documented_examples.html +.. _documented examples: examples.html .. toctree:: :maxdepth: 1 :caption: Contents: tutorials - documented_examples + examples guidelines contributing