Skip to content

bug: syntax error causing broken link #605

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 1 commit into from
Jan 13, 2026
Merged

bug: syntax error causing broken link #605

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions package-structure-code/python-package-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ include:

<!-- TODO: CHANGELOG is not mentioned in either documentation nor peer review -->

```{button-link} https://www.pyopensci.org/python-package-guide/documentation
Copy link
Member Author

@lwasser lwasser Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs-test runs locally when i fix this. it turns out the page renders but it breaks the target populating. (i think)

that's a really interesting bug if that is the issue.

:::{button-link} <https://www.pyopensci.org/python-package-guide/documentation>
:color: info
:class: sd-rounded-pill

Expand All @@ -95,7 +95,7 @@ Click here to read about our packaging documentation requirements.
:::

(src-layout-test)=
## The src/ layout and testing
## The src layout and testing

The benefit of using the **src/package** layout is that it ensures tests are run against the
installed version of your package rather than the files in your package
Expand All @@ -105,7 +105,7 @@ your package is installed.

If `tests/` are outside the **src/package** directory, they aren't included in the package's [wheel](python-wheel). This makes your package size slightly smaller, which places a smaller storage burden on PyPI, and makes them faster to fetch.

- [Read more about reasons to use the **src/package** layout](https://hynek.me/articles/testing-packaging/)
* [Read more about reasons to use the **src/package** layout](https://hynek.me/articles/testing-packaging/)

:::{admonition} How Python discovers and prioritizes importing modules

Expand Down
Loading