Skip to content

Commit c8f7426

Browse files
fix broken links and sphinx errors
1 parent cdfd0c6 commit c8f7426

File tree

5 files changed

+10
-11
lines changed

5 files changed

+10
-11
lines changed

tutorials/1-installable-code.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,8 +414,10 @@ Python versions your package supports. While this won't impact your package buil
414414
Also because we are assuming you're creating a pure Python package, you can remove the following classifiers:
415415

416416
```toml
417+
[
417418
"Programming Language :: Python :: Implementation :: CPython",
418419
"Programming Language :: Python :: Implementation :: PyPy",
420+
]
419421
```
420422

421423
Your new pyproject.toml file should now look something like this:
@@ -615,7 +617,7 @@ In the upcoming lessons you will:
615617
616618
617619
* Add a [README file](add-readme.md) and [LICENSE](add-license-coc.md) to your package
618-
* [Add more metadata to your `pyproject.toml`](5-pyproject-toml.md) file to support PyPI publication.
620+
* [Add more metadata to your `pyproject.toml`](pyproject-toml.md) file to support PyPI publication.
619621
* [Learn how to build your package distribution](publish-pypi) files (**sdist** and **wheel**) and publish to **test PyPI**.
620622
* Finally you will learn how to [publish to **conda-forge**](publish-conda-forge) from **PyPI**.
621623

tutorials/add-license-coc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ You can use your code of conduct as a tool that can be referenced when moderatin
135135
If you are unsure of what language to add to your `CODE_OF_CONDUCT`
136136
file, we suggest that you adopt the [contributor covenant language](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) as a starting place.
137137

138-
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](#)
138+
![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)
139139

140140
### Add your CODE_OF_CONDUCT file
141141

tutorials/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ Then you can create a conda-forge recipe using the [Grayskull](https://github.co
320320
<img src="../images/tutorials/publish-package-pypi-conda.png" alt="Graphic showing the high level packaging workflow. On the left you see a graphic with code, metadata and tests in it. Those items all go into your package. Documentation and data are below that box because they aren't normally published in your packaging wheel distribution. an arrow to the right takes you to a build distribution files box. that box leads you to either publishing to testPyPI or the real PyPI. From PyPI you can then connect to conda-forge for an automated build that sends distributions from PyPI to conda-forge." width="700px">
321321

322322
In the image above, you can see the steps associated with publishing
323-
your package on PyPI and conda-forge. Note that the distribution files that PyPI requires are the [sdist](#python-source-distribution) and [wheel](#python-wheel) files. Once you are ready to make your code publicly installable, you can publish it on PyPI. Once your code is on PyPI it is straight forward to then publish to conda-forge. You create a recipe using the Grayskull package and then you open a pr in the conda-forge recipe repo. You will learn more about this process in the [conda-forge lesson](#).
323+
your package on PyPI and conda-forge. Note that the distribution files that PyPI requires are the [sdist](#python-source-distribution) and [wheel](#python-wheel) files. Once you are ready to make your code publicly installable, you can publish it on PyPI. Once your code is on PyPI it is straight forward to then publish to conda-forge. You create a recipe using the Grayskull package and then you open a pr in the conda-forge recipe repo. You will learn more about this process in the [conda-forge lesson](/tutorials/publish-conda-forge).
324324
:::
325325

326326
## Yay, your package has users! Now what?

tutorials/publish-conda-forge.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -372,10 +372,6 @@ Below we break down each element of that list.
372372
>
373373
> -[x] Package does not ship static libraries. If static libraries are needed, [follow CFEP-18](https://github.com/conda-forge/cfep/blob/main/cfep-18.md).
374374

375-
:::{note}
376-
377-
:::
378-
379375
**Translation:** A static library refers to a copy of a package built into your package. If your package is a pure Python package, then you can check that your package does not ship static libraries as this does not apply to you.
380376

381377
The pyOpenSci tutorials are all pure Python and as such do not use static libraries in a linked or shipped (included in the package distribution) format.

tutorials/pyproject-toml.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Make your Python package PyPI ready - pyproject.toml
22

3-
In [the installable code lesson](2-installable-code), you learned how to add the bare minimum information to a `pyproject.toml` file to make it installable. You then learned how to [publish that bare minimum version of your package to PyPI](publish-pypi.md).
3+
In [the installable code lesson](1-installable-code), you learned how to add the bare minimum information to a `pyproject.toml` file to make it installable. You then learned how to [publish that bare minimum version of your package to PyPI](publish-pypi.md).
44

55
Following that you learned how to add a:
66
* [README.md](add-readme)
@@ -78,7 +78,7 @@ build-backend = "hatchling.build"
7878

7979
The pyproject.toml file tells your build tool:
8080

81-
- What build backend to use to build your package (we are using `hatchling` in this tutorial but there are [many others to chose from](build-backend-options)).
81+
- What build backend to use to build your package (we are using `hatchling` in this tutorial but there are [many others to chose from](/package-structure-code/python-package-build-tools)).
8282
- How and where to retrieve your package's version:
8383
- **statically** where you declare the version `version = "0.1.0"` or
8484
- **dynamically** where the tool looks to the most recent tag in your history to determine the current version.
@@ -280,7 +280,7 @@ You can declare a lower bound using syntax like this:
280280
Note that unless you are building an application, you want to be cautious about pinning dependencies. This is because
281281
users will be installing your package into various environments. A pinned dependency can make resolving an environment more challenging to resolve. As such only pin dependencies to a specific version or bound if you absolutely need to do so.
282282

283-
One build tool that you should be aware of that pins dependencies by default is Poetry. [Read more about how to safely add dependencies with Poetry, here.](../package-structure-code/python-package-build-tools.html#challenges-with-poetry)
283+
One build tool that you should be aware of that pins dependencies by default is Poetry. [Read more about how to safely add dependencies with Poetry, here.](/package-structure-code/python-package-build-tools.html#challenges-with-poetry)
284284
:::
285285

286286
### Requires-python
@@ -318,6 +318,7 @@ classifiers = [
318318
"Programming Language :: Python :: 3 :: Only",
319319
"Programming Language :: Python :: 3.10",
320320
"Programming Language :: Python :: 3.11",
321+
]
321322

322323
dependencies = ["ruamel-yaml>=0.17.21", "requests", "python-dotenv", "pydantic"]
323324

@@ -457,7 +458,7 @@ dependencies = ["xarray", "requests"]
457458
# This is the metadata that pip reads to understand what versions your package supports
458459
requires-python = ">=3.10"
459460
readme = "README.md"
460-
license = { FILE = LICENSE }
461+
license = { FILE = "LICENSE" }
461462

462463
# Add urls for your home page, issue tracker and source code
463464
[project.urls] # Optional

0 commit comments

Comments
 (0)