Skip to content

enh: reorganize #597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lwasser merged 3 commits into from
Dec 11, 2025
Merged

enh: reorganize #597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e21482f
enh: reorganize
lwasser Dec 11, 2025
b45656a
Apply suggestion from @lwasser
lwasser Dec 11, 2025
3f3680b
Apply suggestion from @lwasser
lwasser Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -56,10 +55,10 @@ 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).
## 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -195,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
Expand Down Expand Up @@ -227,7 +224,6 @@ Learn about best practices for:
:class-container: text-center
:gutter: 3


::::{grid-item}
:::{card} ✨ Code style & Format ✨
:class-card: left-aligned
Expand All @@ -249,8 +245,7 @@ contribute.

:::::


:::{figure} https://www.pyopensci.org/images/people-building-blocks.jpg
:::{figure} <https://www.pyopensci.org/images/people-building-blocks.jpg>
: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?
Expand Down Expand Up @@ -286,7 +281,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
Expand All @@ -310,7 +304,6 @@ Documentation <documentation/index>

:::


:::{toctree}
:hidden:
:caption: Testing
Expand All @@ -319,7 +312,6 @@ Tests <tests/index>

:::


:::{toctree}
:hidden:
:caption: Continuous Integration
Expand Down
0 ...ge-structure-code/environment-managers.md → maintain-automate/environment-managers.md
View file
Open in desktop
File renamed without changes.
3 changes: 2 additions & 1 deletion maintain-automate/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ contributors.
:caption: Maintain & Automate
:hidden: true

Task runners <task-runners.md>
What is CI? <ci.md>
Task runners <task-runners.md>
Environment Managers <environment-managers.md>
:::
10 changes: 0 additions & 10 deletions package-structure-code/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -50,7 +48,6 @@ your Python package.
:::
::::


::::{grid-item}
:::{card} ✨ 3. Add metadata ✨
:link: pyproject-toml-python-package-metadata
Expand Down Expand Up @@ -190,13 +187,6 @@ Package Build Tools <python-package-build-tools>
Complex Builds <complex-python-package-builds>
:::

:::{toctree}
:hidden:
:caption: Tools to manage your package

Environment & package managers <environment-managers>
:::

:::{toctree}
:hidden:
:caption: Publish your package
Expand Down
Loading