Skip to content

Commit

Permalink
docs: minor corrections to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mdtanker committed Jul 12, 2024
1 parent 753e3eb commit b23c79f
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/citing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)).
5 changes: 0 additions & 5 deletions docs/how_to/3D_plotting.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 5 additions & 1 deletion docs/how_to/defining_regions.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,11 @@
{
"cell_type": "code",
"execution_count": 3,
"metadata": {},
"metadata": {
"tags": [
"nbsphinx-thumbnail"
]
},
"outputs": [
{
"name": "stderr",
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to/download_NASA_data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.1.-1"
"version": "3.12.3"
},
"vscode": {
"interpreter": {
Expand Down
3 changes: 0 additions & 3 deletions docs/how_to/profiles.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
3 changes: 0 additions & 3 deletions docs/how_to/subplot_layout.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@
},
"outputs": [],
"source": [
"%%capture\n",
"%load_ext autoreload\n",
"%autoreload 2\n",
"import os\n",
"\n",
"import pygmt\n",
Expand Down
4 changes: 1 addition & 3 deletions docs/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@
},
"outputs": [],
"source": [
"%load_ext autoreload\n",
"%autoreload 2\n",
"from polartoolkit import fetch, maps, profiles, regions"
]
},
Expand Down Expand Up @@ -199,7 +197,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.1.-1"
"version": "3.12.3"
},
"vscode": {
"interpreter": {
Expand Down
4 changes: 0 additions & 4 deletions docs/tutorial/05_subplots.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
6 changes: 5 additions & 1 deletion docs/tutorial/09_interactive_data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,11 @@
{
"cell_type": "code",
"execution_count": 4,
"metadata": {},
"metadata": {
"tags": [
"nbsphinx-thumbnail"
]
},
"outputs": [
{
"name": "stderr",
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/10_reprojecting_data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"shell.execute_reply": "2024-02-09T05:05:07.655627Z"
},
"tags": [
"nbshpinx-thumbnail"
"nbsphinx-thumbnail"
]
},
"outputs": [
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorial/utils_walkthrough.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit b23c79f

Please sign in to comment.