From b23c79fbc545db17a43d7171a45f388c8f98f02c Mon Sep 17 00:00:00 2001 From: mdtanker Date: Fri, 12 Jul 2024 19:40:43 +0200 Subject: [PATCH] docs: minor corrections to docs --- docs/citing.md | 2 +- docs/how_to/3D_plotting.ipynb | 5 ----- docs/how_to/defining_regions.ipynb | 6 +++++- docs/how_to/download_NASA_data.ipynb | 2 +- docs/how_to/profiles.ipynb | 3 --- docs/how_to/subplot_layout.ipynb | 3 --- docs/quickstart.ipynb | 4 +--- docs/tutorial/05_subplots.ipynb | 4 ---- docs/tutorial/09_interactive_data.ipynb | 6 +++++- docs/tutorial/10_reprojecting_data.ipynb | 2 +- docs/tutorial/utils_walkthrough.ipynb | 3 --- 11 files changed, 14 insertions(+), 26 deletions(-) diff --git a/docs/citing.md b/docs/citing.md index 3c9e8544..08c95784 100644 --- a/docs/citing.md +++ b/docs/citing.md @@ -9,6 +9,6 @@ Journal of Open Source Software (JOSS) paper still in review ... ``` This is an open-access publication. -The paper and the associated software review can be freely accessed at: https://joss.theoj.org/papers/b3964f290fcd03c7706ef1973bcdf702 +The paper and the associated software review can be freely accessed at: [https://joss.theoj.org/papers/b3964f290fcd03c7706ef1973bcdf702](https://joss.theoj.org/papers/b3964f290fcd03c7706ef1973bcdf702) If you would like to cite the specific version you used, which can improve reproducibility and let users know the state of the software at the time of your analysis, please use the version-specific citation and DOI (available from [Zenodo](https://zenodo.org/doi/10.5281/zenodo.7059091)). \ No newline at end of file diff --git a/docs/how_to/3D_plotting.ipynb b/docs/how_to/3D_plotting.ipynb index 1dbd2390..433fa5a6 100644 --- a/docs/how_to/3D_plotting.ipynb +++ b/docs/how_to/3D_plotting.ipynb @@ -20,11 +20,6 @@ }, "outputs": [], "source": [ - "%%capture\n", - "%load_ext autoreload\n", - "%autoreload 2\n", - "\n", - "# set Python's logging level to get information\n", "import logging\n", "import os\n", "\n", diff --git a/docs/how_to/defining_regions.ipynb b/docs/how_to/defining_regions.ipynb index 334f20dd..e6defb35 100644 --- a/docs/how_to/defining_regions.ipynb +++ b/docs/how_to/defining_regions.ipynb @@ -112,7 +112,11 @@ { "cell_type": "code", "execution_count": 3, - "metadata": {}, + "metadata": { + "tags": [ + "nbsphinx-thumbnail" + ] + }, "outputs": [ { "name": "stderr", diff --git a/docs/how_to/download_NASA_data.ipynb b/docs/how_to/download_NASA_data.ipynb index 28cebc37..33e8c61e 100644 --- a/docs/how_to/download_NASA_data.ipynb +++ b/docs/how_to/download_NASA_data.ipynb @@ -482,7 +482,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.1.-1" + "version": "3.12.3" }, "vscode": { "interpreter": { diff --git a/docs/how_to/profiles.ipynb b/docs/how_to/profiles.ipynb index d3af00a2..f58054ca 100644 --- a/docs/how_to/profiles.ipynb +++ b/docs/how_to/profiles.ipynb @@ -23,9 +23,6 @@ }, "outputs": [], "source": [ - "%%capture\n", - "%load_ext autoreload\n", - "%autoreload 2\n", "import os\n", "\n", "from polartoolkit import fetch, profiles, utils" diff --git a/docs/how_to/subplot_layout.ipynb b/docs/how_to/subplot_layout.ipynb index 0bc48941..9cd3fc01 100644 --- a/docs/how_to/subplot_layout.ipynb +++ b/docs/how_to/subplot_layout.ipynb @@ -20,9 +20,6 @@ }, "outputs": [], "source": [ - "%%capture\n", - "%load_ext autoreload\n", - "%autoreload 2\n", "import os\n", "\n", "import pygmt\n", diff --git a/docs/quickstart.ipynb b/docs/quickstart.ipynb index 5ba9653c..033c32d0 100644 --- a/docs/quickstart.ipynb +++ b/docs/quickstart.ipynb @@ -29,8 +29,6 @@ }, "outputs": [], "source": [ - "%load_ext autoreload\n", - "%autoreload 2\n", "from polartoolkit import fetch, maps, profiles, regions" ] }, @@ -199,7 +197,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.1.-1" + "version": "3.12.3" }, "vscode": { "interpreter": { diff --git a/docs/tutorial/05_subplots.ipynb b/docs/tutorial/05_subplots.ipynb index ab2adb4e..20bb3fa2 100644 --- a/docs/tutorial/05_subplots.ipynb +++ b/docs/tutorial/05_subplots.ipynb @@ -28,10 +28,6 @@ }, "outputs": [], "source": [ - "%%capture\n", - "%load_ext autoreload\n", - "%autoreload 2\n", - "\n", "import os\n", "\n", "from polartoolkit import fetch, maps" diff --git a/docs/tutorial/09_interactive_data.ipynb b/docs/tutorial/09_interactive_data.ipynb index 10f1e737..c1c40c40 100644 --- a/docs/tutorial/09_interactive_data.ipynb +++ b/docs/tutorial/09_interactive_data.ipynb @@ -70,7 +70,11 @@ { "cell_type": "code", "execution_count": 4, - "metadata": {}, + "metadata": { + "tags": [ + "nbsphinx-thumbnail" + ] + }, "outputs": [ { "name": "stderr", diff --git a/docs/tutorial/10_reprojecting_data.ipynb b/docs/tutorial/10_reprojecting_data.ipynb index b2a78cf6..7d28004b 100644 --- a/docs/tutorial/10_reprojecting_data.ipynb +++ b/docs/tutorial/10_reprojecting_data.ipynb @@ -89,7 +89,7 @@ "shell.execute_reply": "2024-02-09T05:05:07.655627Z" }, "tags": [ - "nbshpinx-thumbnail" + "nbsphinx-thumbnail" ] }, "outputs": [ diff --git a/docs/tutorial/utils_walkthrough.ipynb b/docs/tutorial/utils_walkthrough.ipynb index 490183f6..419b8e88 100644 --- a/docs/tutorial/utils_walkthrough.ipynb +++ b/docs/tutorial/utils_walkthrough.ipynb @@ -20,9 +20,6 @@ }, "outputs": [], "source": [ - "%%capture\n", - "%load_ext autoreload\n", - "%autoreload 2\n", "import os\n", "\n", "from polartoolkit import fetch, maps, regions, utils"