Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion maintain-automate/dev-installs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Installing your own code
# Installing your own code

You have a conda environment. It works. Maybe it has packages that were hard to install, like GDAL, HDF5, or other compiled scientific dependencies.

Expand Down
5 changes: 5 additions & 0 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@
# Sphinx parameters used to test the build of the guide
TEST_PARAMETERS = ["--keep-going", "-E", "-a"]

# Fail the build on warnings (English build in CI).
# Not yet applied to translations. See follow-up issue.
STRICT_PARAMETERS = ["--fail-on-warning"]

# Sphinx parameters to generate translation templates
TRANSLATION_TEMPLATE_PARAMETERS = ["-b", "gettext"]

Expand Down Expand Up @@ -112,6 +116,7 @@ def docs_test(session):
SPHINX_BUILD,
*BUILD_PARAMETERS,
*TEST_PARAMETERS,
*STRICT_PARAMETERS,
SOURCE_DIR,
OUTPUT_DIR,
*session.posargs,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The metadata that both build tools and PyPI uses to describe and understand your
:::{literalinclude} ../examples/pure-hatch/pyproject.toml
:language: toml
:start-at: dependencies = [
:end-before: [development-group]
:end-before: [dependency-groups]
:::

2. When the build tool creates your package distribution file (the file that you publish on PyPI), it also creates a METADATA file which PyPI can read and use to help users find your package. For example:
Expand Down
2 changes: 1 addition & 1 deletion tests/run-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ The additional tools or options to run with the tests is specified under `[tool.

:::{literalinclude} ../examples/pure-hatch/pyproject.toml
:language: toml
:start-at: [development-group]
:start-at: [dependency-groups]
:end-before: lint
:::

Expand Down
6 changes: 3 additions & 3 deletions tutorials/pyproject-toml.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ dependencies = [

Your `pyproject.toml` file will now look like this:

{emphasize-lines="24"}
{emphasize-lines="23"}
```toml
[build-system]
requires = ["hatchling"]
Expand Down Expand Up @@ -458,7 +458,7 @@ The classifier key should look something like the example below. A few notes:
- Your classifier values might be different depending upon your intended audience, development status of your package and the Python versions that you support
- You can add as many classifiers as you wish as long as you use the [designated PyPI classifier values](https://PyPI.org/classifiers/).

{emphasize-lines="26-33"}
{emphasize-lines="25-32"}
```toml
[build-system]
requires = ["hatchling"]
Expand Down Expand Up @@ -506,7 +506,7 @@ Finally, add the project.urls table to your pyproject.toml file.
- **Bug reports:** a link to your issues/discussions or wherever you want users to report bugs.
- **Source:** the GitHub / GitLab link for your project.

{emphasize-lines="35-38"}
{emphasize-lines="34-37"}
```toml
[build-system]
requires = ["hatchling"]
Expand Down
Loading