Skip to content

Commit d81cf26

Browse files
authored
enh: reorganize (#597)
* enh: reorganize * Apply suggestion from @lwasser * Apply suggestion from @lwasser
1 parent fbf098c commit d81cf26

File tree

4 files changed

+5
-22
lines changed

4 files changed

+5
-22
lines changed

index.md

Lines changed: 3 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,10 +55,10 @@ Community docs
5655
5756
Publish your docs
5857
```
59-
## _new_ Tutorial Series: Create a Python Package
6058

61-
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).
59+
## Tutorial Series: Create a Python Package
6260

61+
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).
6362

6463
:::::{grid} 1 1 2 2
6564
:class-container: text-center
@@ -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,6 @@ 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)*
199196

200197
:::::{grid} 1 1 2 2
201198
:class-container: text-center
@@ -227,7 +224,6 @@ Learn about best practices for:
227224
:class-container: text-center
228225
:gutter: 3
229226

230-
231227
::::{grid-item}
232228
:::{card} ✨ Code style & Format ✨
233229
:class-card: left-aligned
@@ -249,8 +245,7 @@ contribute.
249245

250246
:::::
251247

252-
253-
:::{figure} https://www.pyopensci.org/images/people-building-blocks.jpg
248+
:::{figure} <https://www.pyopensci.org/images/people-building-blocks.jpg>
254249
:align: right
255250
:width: 350
256251
: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 +281,6 @@ If you have questions about our peer review process or packaging in general, you
286281

287282
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.
288283

289-
290284
:::{toctree}
291285
:hidden:
292286
:caption: Tutorials
@@ -310,7 +304,6 @@ Documentation <documentation/index>
310304

311305
:::
312306

313-
314307
:::{toctree}
315308
:hidden:
316309
:caption: Testing
@@ -319,7 +312,6 @@ Tests <tests/index>
319312

320313
:::
321314

322-
323315
:::{toctree}
324316
:hidden:
325317
:caption: Continuous Integration
File renamed without changes.

maintain-automate/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ contributors.
4747
:caption: Maintain & Automate
4848
:hidden: true
4949

50-
Task runners <task-runners.md>
5150
What is CI? <ci.md>
51+
Task runners <task-runners.md>
52+
Environment Managers <environment-managers.md>
5253
:::

package-structure-code/intro.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,10 @@ Checkout our beginning-to-end create a Python package tutorials
1919

2020
:::
2121

22-
2322
:::{admonition} How this content is developed
2423
All of the content in this guide has been vetted by community members, including maintainers and developers of the core packaging tools.
2524
:::
2625

27-
2826
:::::{grid} 1 1 2 2
2927
:class-container: text-center
3028
:gutter: 3
@@ -50,7 +48,6 @@ your Python package.
5048
:::
5149
::::
5250

53-
5451
::::{grid-item}
5552
:::{card} ✨ 3. Add metadata ✨
5653
:link: pyproject-toml-python-package-metadata
@@ -190,13 +187,6 @@ Package Build Tools <python-package-build-tools>
190187
Complex Builds <complex-python-package-builds>
191188
:::
192189

193-
:::{toctree}
194-
:hidden:
195-
:caption: Tools to manage your package
196-
197-
Environment & package managers <environment-managers>
198-
:::
199-
200190
:::{toctree}
201191
:hidden:
202192
:caption: Publish your package

0 commit comments

Comments
 (0)