Skip to content

Commit fc8cb69

Browse files
authored
FIX: Fix for many doc warnings in doc build. (#1841)
* FIX: Fix for many doc warnings in doc build. * FIX: Update notebooks as well. * FIX: Fix issue with references. * FIX: Update contributing.rst to remove warnings. * FIX: Update pandas doc url.
1 parent 21aaa4a commit fc8cb69

9 files changed

Lines changed: 771 additions & 776 deletions

File tree

CONTRIBUTING.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,7 @@ but you would like to start a new branch with a different task in mind. It
369369
is recommended that your new branch is based on your main. First::
370370

371371
git checkout main
372+
372373
Then::
373374

374375
git checkout -b <branch_name>

doc/source/blog_posts/2022/first_pullrequest.ipynb

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"id": "078c1e00",
4242
"metadata": {},
4343
"source": [
44-
"### First, if you have not done so already, you will need to fork the Py-ART github repository"
44+
"## First, if you have not done so already, you will need to fork the Py-ART github repository"
4545
]
4646
},
4747
{
@@ -59,7 +59,7 @@
5959
"id": "6c992b02",
6060
"metadata": {},
6161
"source": [
62-
"### Second, in a terminal, you will need to clone your remote fork with the \"git clone\" command"
62+
"## Second, in a terminal, you will need to clone your remote fork with the \"git clone\" command"
6363
]
6464
},
6565
{
@@ -85,7 +85,7 @@
8585
"id": "084939e0",
8686
"metadata": {},
8787
"source": [
88-
"### Third, create the \"pyart-docs\" conda environment "
88+
"## Third, create the \"pyart-docs\" conda environment "
8989
]
9090
},
9191
{
@@ -115,7 +115,7 @@
115115
"id": "7cbd8f66",
116116
"metadata": {},
117117
"source": [
118-
"### Fourth, we will need to install the ([TRMM RSL Library](https://trmm-fc.gsfc.nasa.gov/trmm_gv/software/rsl/))"
118+
"## Fourth, we will need to install the ([TRMM RSL Library](https://trmm-fc.gsfc.nasa.gov/trmm_gv/software/rsl/))"
119119
]
120120
},
121121
{
@@ -137,7 +137,7 @@
137137
"metadata": {},
138138
"outputs": [],
139139
"source": [
140-
" ./configure"
140+
"./configure"
141141
]
142142
},
143143
{
@@ -147,7 +147,7 @@
147147
"metadata": {},
148148
"outputs": [],
149149
"source": [
150-
" make install "
150+
"make install "
151151
]
152152
},
153153
{
@@ -173,7 +173,7 @@
173173
"id": "9230ebe3",
174174
"metadata": {},
175175
"source": [
176-
"### Lastly, activate the 'pyart-docs' environment and install the python script within your forked repository"
176+
"## Lastly, activate the 'pyart-docs' environment and install the python script within your forked repository"
177177
]
178178
},
179179
{
@@ -183,7 +183,7 @@
183183
"metadata": {},
184184
"outputs": [],
185185
"source": [
186-
" pip install -e ."
186+
"pip install -e ."
187187
]
188188
},
189189
{
@@ -199,7 +199,7 @@
199199
"id": "025093cb",
200200
"metadata": {},
201201
"source": [
202-
"##### 1. First, create a New Branch for our Changes"
202+
"1. First, create a New Branch for our Changes"
203203
]
204204
},
205205
{
@@ -217,7 +217,7 @@
217217
"id": "d565a5e8",
218218
"metadata": {},
219219
"source": [
220-
"##### 2. Push New Branch To Remote"
220+
"2. Push New Branch To Remote"
221221
]
222222
},
223223
{
@@ -611,7 +611,7 @@
611611
"author": "Joe O'Brien",
612612
"date": "2022-04-26",
613613
"kernelspec": {
614-
"display_name": "Python 3",
614+
"display_name": "Python 3 (ipykernel)",
615615
"language": "python",
616616
"name": "python3"
617617
},
@@ -625,7 +625,7 @@
625625
"name": "python",
626626
"nbconvert_exporter": "python",
627627
"pygments_lexer": "ipython3",
628-
"version": "3.10.8 (main, Oct 13 2022, 09:48:40) [Clang 14.0.0 (clang-1400.0.29.102)]"
628+
"version": "3.13.2"
629629
},
630630
"vscode": {
631631
"interpreter": {

0 commit comments

Comments
 (0)