Skip to content

Commit 2a2329d

Browse files
committed
fix(docs): demote headings in pyproject partial to nest under sections
`_partials/pyproject.md` opened with an H1 that got inlined mid-page in the two packaging guides, which include it at the `##`-section level. Demote each heading one level so it nests correctly, and add a `rumdl-disable MD041` since the file now starts with an H2 (same pattern as footer.md). Assisted-by: ClaudeCode:claude-opus-4.8
1 parent db399f7 commit 2a2329d

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

docs/_partials/pyproject.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# pyproject.toml: project table
1+
<!-- rumdl-disable MD041 -->
2+
3+
## pyproject.toml: project table
24

35
<!-- [[[cog
46
from cog_helpers import code_fence, render_cookie, TOMLMatcher
@@ -64,7 +66,7 @@ special, and replaces the old url setting.
6466
If you use the above configuration, you need `README.md` and `LICENSE` files,
6567
since they are explicitly specified.
6668

67-
## License
69+
### License
6870

6971
The license can be done one of two ways.
7072

@@ -91,7 +93,7 @@ classifiers = [
9193
You should not include the `License ::` classifiers if you use the `license`
9294
field {rr}`PP007`.
9395

94-
### Extras
96+
#### Extras
9597

9698
Sometimes you want to ship a package with optional dependencies. For example,
9799
you might have extra requirements that are only needed for running a CLI, or for
@@ -113,7 +115,7 @@ mpl = [
113115
Self dependencies can be used by using the name of the package, such as
114116
`all = ["package[cli,mpl]"]`, (requires Pip 21.2+).
115117

116-
### Command line
118+
#### Command line
117119

118120
If you want to ship an "app" that a user can run from the command line, you need
119121
to add a `script` entry point. The form is:
@@ -128,7 +130,7 @@ function, followed by a colon, then the function to call. If you use
128130
`__main__.py` as the file, then `python -m` followed by the module will also
129131
work to call the app (`__name__` will be `"__main__"` in that case).
130132

131-
### Development dependencies
133+
#### Development dependencies
132134

133135
The proper way to specify dependencies exclusively used for development tasks
134136
(such as `pytest`, `ruff`, packages for generating documentation, etc.) is to

0 commit comments

Comments
 (0)