sphinx-better-fieldlist
Renders Sphinx field lists as definition lists, with types and defaults from signatures
Motivation
Development
Testing
uv run doit test: runs the test suite against the locked (latest) Sphinx versionuv run nox: runs the test suite against each supported Python version, plus older Sphinx versions (8.2, 7.4) via thecompatsessions; these are supported on a best-effort basis
Snapshots
Snapshot tests in test/test_integration.py compare the field lists generated for an example module (via autodoc and autodoc2) against pseudo-XML stored in test/snapshots/. They only run with the Sphinx version given by LATEST_SPHINX in test/bfl_testing.py, and are skipped for older versions.
Regenerate snapshots when output changes intentionally, or after upgrading Sphinx:
-
If Sphinx was upgraded to a new minor version, update
LATEST_SPHINXto match -
Regenerate snapshots:
BFL_UPDATE_SNAPSHOTS=1 uv run pytest -k snapshot
-
Review changes with
git diff test/snapshots/to confirm they're expected -
Run
uv run doit testto confirm the snapshots pass
1 maintainer
Metadata
1 maintainer
Release files for sphinx-better-fieldlist 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinx_better_fieldlist-0.1.0.tar.gz | 13.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_better_fieldlist-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 30.6 kB
Release files / sphinx_better_fieldlist-0.1.0.tar.gz
| Download URL | sphinx_better_fieldlist-0.1.0.tar.gz |
|---|---|
| Size | 13.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
20a9898b2043297b0a3eeeefb69a1ff6f16775500bb67bf7458c880867098ecc
|
|
BLAKE2b-256 checksum How to use checksums |
19568f7f6b0287feb89f6ceeacb25759d990f3deebe279784df66d31e531e58c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / sphinx_better_fieldlist-0.1.0-py3-none-any.whl
| Download URL | sphinx_better_fieldlist-0.1.0-py3-none-any.whl |
|---|---|
| Size | 17.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
89ba35e2a90d4b20b8f0cc1131632c7dd0cc0b527f6fb33e93768ac137521f04
|
|
BLAKE2b-256 checksum How to use checksums |
8c5054aad7e3076677d19341cbae27bc7bb00d7f1d2aa816abc7ae7ae0dad0f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for sphinx-better-fieldlist 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
