Skip to content

Commit 57d9cdb

Browse files
committed
fix: broken sphinx things
1 parent 921c200 commit 57d9cdb

File tree

3 files changed

+6
-11
lines changed

3 files changed

+6
-11
lines changed

package-structure-code/intro.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ best practices. Here, we review tool features and suggest tools you can use
1212
for your Python packaging workflow.
1313

1414
:::{button-link} /tutorials/intro
15-
:color: primary
15+
:color: success
1616
:class: sd-rounded-pill float-left
1717

1818
Checkout our beginning-to-end create a Python package tutorials
@@ -25,12 +25,6 @@ All of the content in this guide has been vetted by community members, including
2525
:::
2626

2727

28-
29-
:::{button}
30-
:class: bdg-success
31-
Check out our Python package
32-
:::
33-
3428
:::::{grid} 1 1 2 2
3529
:class-container: text-center
3630
:gutter: 3

package-structure-code/python-package-structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Note: Python versions 3.11 and above have a path setting that can be adjusted to
118118

119119
### Don't include tests in your package wheel
120120

121-
Writing [tests](/tests/index.html) for your package is important; however, we do not recommend including tests as part of your [package wheel](python-wheel) by default. However, not including tests in your package distribution will make it harder for people other than yourself to test whether your package runs properly on their system. If you have a small test suite (Python files + data), and think your users may want to run tests locally on their systems, you can include tests by moving the `tests/` directory into the **src/package** directory (see example below).
121+
Writing [tests](tests-intro) for your package is important; however, we do not recommend including tests as part of your [package wheel](python-wheel) by default. However, not including tests in your package distribution will make it harder for people other than yourself to test whether your package runs properly on their system. If you have a small test suite (Python files + data), and think your users may want to run tests locally on their systems, you can include tests by moving the `tests/` directory into the **src/package** directory (see example below).
122122

123123
```bash
124124
src/
@@ -150,7 +150,7 @@ host your test data in a repository such as Figshare or Zenodo. Use a
150150
tool such as [Pooch](https://www.fatiando.org/pooch/latest/) to access
151151
the data when you (or a user) runs tests.
152152

153-
For more information about Python package tests, see the [tests section of our guide](/tests/index.html).
153+
For more information about Python package tests, see the [tests section of our guide](tests-intro).
154154

155155
- The **src/package** layout is semantically more clear. Code is always found in the
156156
**src/package** directory, `tests/` and `docs/`are in the root directory.

tests/index.md

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

34
Tests are an important part of your Python package because they
45
provide a set of checks that ensure that your package is
56
functioning how you expect it to.
67

7-
In this section you will learn more about the importance of writing
8-
tests for your Python package and how you can setup infrastructure
8+
In this section, you will learn more about the importance of writing
9+
tests for your Python package and how you can set up infrastructure
910
to run your tests both locally and on GitHub.
1011

1112

0 commit comments

Comments
 (0)