antsibull-docutils -- Antsibull docutils helpers
A Python library with some docutils helpers used by Antsibull tools.
antsibull-docutils is covered by the Ansible Code of Conduct.
Docutils support
In CI, compatibility with docutils 0.18+ is tested. Older versions of docutils might work as well, depending on your use-case. The tests do not pass for 0.16 and 0.17, as these versions emit different IDs and HTML (for tables). 0.16 also handles code blocks differently, and they will not be emitted with the MarkDown renderer.
Development
Install and run nox to run all tests. That's it for simple contributions!
nox will create virtual environments in .nox inside the checked out project
and install the requirements needed to run the tests there.
To run specific tests:
nox -e testto only run unit tests;nox -e coverageto display combined coverage results after runningnox -e test integration;nox -e lintto run all linters and formatters at once;nox -e formattersto runisortandblack;nox -e codeqato runflake8,pylint,reuse lint, andantsibull-changelog lint;nox -e typingto runmypy.
Creating a new release:
- Run
nox -e bump -- <version> <release_summary_message>. This:- Bumps the package version in
src/antsibull_docutils/__init__.py. - Creates
changelogs/fragments/<version>.ymlwith arelease_summarysection. - Runs
antsibull-changelog releaseand adds the changed files to git. - Commits with message
Release <version>.and runsgit tag -a -m 'antsibull-docutils <version>' <version>. - Runs
hatch build --clean.
- Bumps the package version in
- Run
git pushto the appropriate remotes. - Once CI passes on GitHub, run
nox -e publish. This:- Runs
hatch publish; - Bumps the version to
<version>.post0; - Adds the changed file to git and run
git commit -m 'Post-release version bump.';
- Runs
- Run
git push --follow-tagsto the appropriate remotes and create a GitHub release.
License
Unless otherwise noted in the code, it is licensed under the terms of the GNU General Public License v3 or, at your option, later. See LICENSES/GPL-3.0-or-later.txt for a copy of the license.
The repository follows the REUSE Specification for declaring copyright and
licensing information. The only exception are changelog fragments in changelog/fragments/.
Metadata
Release files for antsibull-docutils 1.5.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 | Actions |
|---|---|---|---|---|
| antsibull_docutils-1.5.0.tar.gz | 70.4 kB | Without provenance | Details for antsibull_docutils-1.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| antsibull_docutils-1.5.0-py3-none-any.whl | Python 3 | none | any | Details for antsibull_docutils-1.5.0-py3-none-any.whl |
Total release size: 123.2 kB
Release files / antsibull_docutils-1.5.0.tar.gz
| Download URL | antsibull_docutils-1.5.0.tar.gz |
|---|---|
| Size | 70.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d325c2ce57cde5343bf50e647e2e7714718337748b1a9db5a1b529a2dd765603
|
|
BLAKE2b-256 checksum How to use checksums |
a108c5eb1cf6f2f07b3042aaec24506b139cbd522c9b6e93842fd85e3a161232
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.18.2 {"ci":null,"cpu":"x86_64","distro":{"id":"n/a","libc":{"lib":"glibc","version":"2.44"},"name":"Arch Linux","version":"rolling"},"implementation":{"name":"CPython","version":"3.14.8"},"installer":{"name":"hatch","version":"1.18.2"},"openssl_version":"OpenSSL 3.6.5 29 Sep 2026","python":"3.14.8","system":{"name":"Linux","release":"7.2.11-arch1-1"}} HTTPX2/2.16.0
|
Release files / antsibull_docutils-1.5.0-py3-none-any.whl
| Download URL | antsibull_docutils-1.5.0-py3-none-any.whl |
|---|---|
| Size | 52.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9f8f4293bc4d8a0e70f99f64c3c4c39d4953c32f817568222ac23f9ac6c2d351
|
|
BLAKE2b-256 checksum How to use checksums |
4e3aa2f4e50b84994603a7e4ce52ce76beb102c1792bae3bea017a7865ca428a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.18.2 {"ci":null,"cpu":"x86_64","distro":{"id":"n/a","libc":{"lib":"glibc","version":"2.44"},"name":"Arch Linux","version":"rolling"},"implementation":{"name":"CPython","version":"3.14.8"},"installer":{"name":"hatch","version":"1.18.2"},"openssl_version":"OpenSSL 3.6.5 29 Sep 2026","python":"3.14.8","system":{"name":"Linux","release":"7.2.11-arch1-1"}} HTTPX2/2.16.0
|
Security for antsibull-docutils 1.5.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.