Python library for processing Ansible documentation markup
Project description
antsibull-docs-parser - Python library for processing Ansible documentation markup
This is a Python library for processing Ansible documentation markup. It is named after antsibull-docs where this code originates from. It was moved out to make it easier to reuse the markup code in other projects without having to depend on all of antsibull-docs's dependencies.
Development
Install and run nox
to run all tests. 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 test
to only run unit tests;nox -e lint
to run all linters and formatters at once;nox -e formatters
to runisort
andblack
;nox -e codeqa
to runflake8
,pylint
,reuse lint
, andantsibull-changelog lint
;nox -e typing
to runmypy
andpyre
;nox -e create_vectors
to update thetest-vectors.yml
file. Please note that this file should be synchronized with the corresponding file in the antsibull-docs-ts project.
Releasing a new version
- Run
nox -e bump -- <version> <release_summary_message>
. This:- Bumps the package version in
src/antsibull_docs_parser/__init__.py
. - Creates
changelogs/fragments/<version>.yml
with arelease_summary
section. - Runs
antsibull-changelog release
and adds the changed files to git. - Commits with message
Release <version>.
and runsgit tag -a -m 'antsibull-docs-parser <version>' <version>
. - Runs
hatch build --clean
.
- Bumps the package version in
- Run
git push
to 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-tags
to the appropriate remotes and create a GitHub release.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file antsibull_docs_parser-1.1.0.tar.gz
.
File metadata
- Download URL: antsibull_docs_parser-1.1.0.tar.gz
- Upload date:
- Size: 55.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b94400918343677119c38344bf3bd867a937259f8d09fddc68deae2741ba056 |
|
MD5 | c6dac9e0c71c9c8e633c56c110660b1f |
|
BLAKE2b-256 | 3bda479125fd5478ce87e671bf0457b3b8b0dc9fc6ea0da1087900461c70da0e |
Provenance
File details
Details for the file antsibull_docs_parser-1.1.0-py3-none-any.whl
.
File metadata
- Download URL: antsibull_docs_parser-1.1.0-py3-none-any.whl
- Upload date:
- Size: 33.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.27.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b29490908cd51660cc2b98d6af45b64db938e529f50e84aec416971820013450 |
|
MD5 | dc0dd482b91d68b6c65383c06d389d43 |
|
BLAKE2b-256 | ff7981b043730c2705f542832c5267fe5bd9c93559929a3502e9362036a8cdc1 |