From e21482fdf7436dfd39e1c0b2136ca4e3e9436f54 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Thu, 11 Dec 2025 10:44:59 -0700 Subject: [PATCH 1/3] enh: reorganize --- index.md | 13 +++---------- .../environment-managers.md | 0 maintain-automate/index.md | 3 ++- package-structure-code/intro.md | 10 ---------- 4 files changed, 5 insertions(+), 21 deletions(-) rename {package-structure-code => maintain-automate}/environment-managers.md (100%) diff --git a/index.md b/index.md index f0b3ec2d..c2f2a851 100644 --- a/index.md +++ b/index.md @@ -42,7 +42,6 @@ This guide will help you: You will also find best practice recommendations and curated lists of community resources surrounding packaging and package documentation. :::: - ```{todo} TODO: change the navigation of docs to have a @@ -56,11 +55,11 @@ Community docs Publish your docs ``` + ## _new_ Tutorial Series: Create a Python Package 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). - :::::{grid} 1 1 2 2 :class-container: text-center :gutter: 3 @@ -107,7 +106,6 @@ The first round of our community-developed, how to create a Python package tutor ::::: - ## Python Packaging for Scientists Learn about Python packaging best practices. You will also get to know the @@ -195,7 +193,7 @@ Learn about best practices for: ## Tests -*We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)* +_We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)_ :::::{grid} 1 1 2 2 :class-container: text-center @@ -227,7 +225,6 @@ Learn about best practices for: :class-container: text-center :gutter: 3 - ::::{grid-item} :::{card} ✨ Code style & Format ✨ :class-card: left-aligned @@ -249,8 +246,7 @@ contribute. ::::: - -:::{figure} https://www.pyopensci.org/images/people-building-blocks.jpg +:::{figure} :align: right :width: 350 :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 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. - :::{toctree} :hidden: :caption: Tutorials @@ -310,7 +305,6 @@ Documentation ::: - :::{toctree} :hidden: :caption: Testing @@ -319,7 +313,6 @@ Tests ::: - :::{toctree} :hidden: :caption: Continuous Integration diff --git a/package-structure-code/environment-managers.md b/maintain-automate/environment-managers.md similarity index 100% rename from package-structure-code/environment-managers.md rename to maintain-automate/environment-managers.md diff --git a/maintain-automate/index.md b/maintain-automate/index.md index 7545e2a0..5df9412b 100644 --- a/maintain-automate/index.md +++ b/maintain-automate/index.md @@ -47,6 +47,7 @@ contributors. :caption: Maintain & Automate :hidden: true -Task runners What is CI? +Task runners +Environment Managers ::: diff --git a/package-structure-code/intro.md b/package-structure-code/intro.md index c6157787..bc6c9b03 100644 --- a/package-structure-code/intro.md +++ b/package-structure-code/intro.md @@ -19,12 +19,10 @@ Checkout our beginning-to-end create a Python package tutorials ::: - :::{admonition} How this content is developed All of the content in this guide has been vetted by community members, including maintainers and developers of the core packaging tools. ::: - :::::{grid} 1 1 2 2 :class-container: text-center :gutter: 3 @@ -50,7 +48,6 @@ your Python package. ::: :::: - ::::{grid-item} :::{card} ✨ 3. Add metadata ✨ :link: pyproject-toml-python-package-metadata @@ -190,13 +187,6 @@ Package Build Tools Complex Builds ::: -:::{toctree} -:hidden: -:caption: Tools to manage your package - -Environment & package managers -::: - :::{toctree} :hidden: :caption: Publish your package From b45656a0d1ca242375da716fbd410a1015e8256c Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Thu, 11 Dec 2025 10:46:01 -0700 Subject: [PATCH 2/3] Apply suggestion from @lwasser --- index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/index.md b/index.md index c2f2a851..e71828b4 100644 --- a/index.md +++ b/index.md @@ -193,7 +193,6 @@ Learn about best practices for: ## Tests -_We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)_ :::::{grid} 1 1 2 2 :class-container: text-center From 3f3680b54f7e5cc3ff50bddddaca688245486f75 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Thu, 11 Dec 2025 10:46:26 -0700 Subject: [PATCH 3/3] Apply suggestion from @lwasser --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index e71828b4..a5d5d4b4 100644 --- a/index.md +++ b/index.md @@ -56,7 +56,7 @@ Community docs Publish your docs ``` -## _new_ Tutorial Series: Create a Python Package +## Tutorial Series: Create a Python Package 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).