Skip to content

Commit ec668a4

Browse files
committed
enh: add data page to tests section
1 parent 22c275f commit ec668a4

File tree

4 files changed

+372
-199
lines changed

4 files changed

+372
-199
lines changed

data/intro.md

Lines changed: 0 additions & 186 deletions
This file was deleted.

index.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ This guide will help you:
4242
You will also find best practice recommendations and curated lists of community resources surrounding packaging and package documentation.
4343
::::
4444

45-
4645
```{todo}
4746
TODO: change the navigation of docs to have a
4847
@@ -56,11 +55,11 @@ Community docs
5655
5756
Publish your docs
5857
```
58+
5959
## _new_ Tutorial Series: Create a Python Package
6060

6161
The first round of our community-developed, how to create a Python package tutorial series for scientists is complete! Join our community review process or watch development of future tutorials in our [GitHub repo here](https://github.com/pyOpenSci/python-package-guide).
6262

63-
6463
:::::{grid} 1 1 2 2
6564
:class-container: text-center
6665
:gutter: 3
@@ -107,7 +106,6 @@ The first round of our community-developed, how to create a Python package tutor
107106

108107
:::::
109108

110-
111109
## Python Packaging for Scientists
112110

113111
Learn about Python packaging best practices. You will also get to know the
@@ -195,7 +193,7 @@ Learn about best practices for:
195193

196194
## Tests
197195

198-
*We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)*
196+
_We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)_
199197

200198
:::::{grid} 1 1 2 2
201199
:class-container: text-center
@@ -227,7 +225,6 @@ Learn about best practices for:
227225
:class-container: text-center
228226
:gutter: 3
229227

230-
231228
::::{grid-item}
232229
:::{card} ✨ Code style & Format ✨
233230
:class-card: left-aligned
@@ -249,8 +246,7 @@ contribute.
249246

250247
:::::
251248

252-
253-
:::{figure} https://www.pyopensci.org/images/people-building-blocks.jpg
249+
:::{figure} <https://www.pyopensci.org/images/people-building-blocks.jpg>
254250
:align: right
255251
:width: 350
256252
:alt: xkcd comic showing a stick figure on the ground and one in the air. The one on the ground is saying. `You're flying! how?` The person in the air replies `Python!` Below is a 3 rectangle comic with the following text in each box. Box 1 - I learned it last night. Everything is so simple. Hello world is just print hello world. Box 2 - the person on the ground says - come join us programming is fun again. It's a whole new world. But how are you flying? box 3 - the person flying says - i just typed import antigravity. I also sampled everything in the medicine cabinet. But i think this is the python. The person on the ground is saying - that's it?
@@ -286,7 +282,6 @@ If you have questions about our peer review process or packaging in general, you
286282

287283
This living Python packaging guide is updated as tools and best practices evolve in the Python packaging ecosystem. We will be adding new content over the next year.
288284

289-
290285
:::{toctree}
291286
:hidden:
292287
:caption: Tutorials
@@ -310,16 +305,14 @@ Documentation <documentation/index>
310305

311306
:::
312307

313-
314308
:::{toctree}
315309
:hidden:
316-
:caption: Testing
310+
:caption: Tests & Data
317311

318312
Tests <tests/index>
319313

320314
:::
321315

322-
323316
:::{toctree}
324317
:hidden:
325318
:caption: Continuous Integration

tests/index.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
(tests-intro)=
2+
23
# Tests and data for your Python package
34

45
Tests are an important part of your Python package because they
@@ -9,7 +10,6 @@ In this section, you will learn more about the importance of writing
910
tests for your Python package and how you can set up infrastructure
1011
to run your tests both locally and on GitHub.
1112

12-
1313
:::::{grid} 1 1 3 2
1414
:class-container: text-center
1515
:gutter: 3
@@ -62,7 +62,6 @@ and different operating systems. Learn about setting up tests to run in Continuo
6262

6363
:::::
6464

65-
6665
:::{figure-md} fig-target
6766

6867
<img src="../images/packaging-lifecycle.png" alt="" width="800px">
@@ -82,3 +81,11 @@ Run tests locally <run-tests>
8281
Run tests online (using CI) <tests-ci>
8382
Code coverage <code-cov>
8483
```
84+
85+
```{toctree}
86+
:hidden:
87+
:maxdepth: 2
88+
:caption: Data for Your Package
89+
90+
Package Data <package-data>
91+
```

0 commit comments

Comments
 (0)