Skip to main content

Python library for processing Ansible documentation markup

Project description

antsibull-docs-parser - Python library for processing Ansible documentation markup

Discuss on Matrix at #antsibull:ansible.com Nox badge Codecov badge REUSE status

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:

  1. nox -e test to only run unit tests;
  2. nox -e lint to run all linters and formatters at once;
  3. nox -e formatters to run isort and black;
  4. nox -e codeqa to run flake8, pylint, reuse lint, and antsibull-changelog lint;
  5. nox -e typing to run mypy and pyre;
  6. nox -e create_vectors to update the test-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

  1. 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 a release_summary section.
    • Runs antsibull-changelog release and adds the changed files to git.
    • Commits with message Release <version>. and runs git tag -a -m 'antsibull-docs-parser <version>' <version>.
    • Runs hatch build --clean.
  2. Run git push to the appropriate remotes.
  3. 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.';
  4. 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

antsibull_docs_parser-1.1.0.tar.gz (55.2 kB view details)

Uploaded Source

Built Distribution

antsibull_docs_parser-1.1.0-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

Details for the file antsibull_docs_parser-1.1.0.tar.gz.

File metadata

File hashes

Hashes for antsibull_docs_parser-1.1.0.tar.gz
Algorithm Hash digest
SHA256 9b94400918343677119c38344bf3bd867a937259f8d09fddc68deae2741ba056
MD5 c6dac9e0c71c9c8e633c56c110660b1f
BLAKE2b-256 3bda479125fd5478ce87e671bf0457b3b8b0dc9fc6ea0da1087900461c70da0e

See more details on using hashes here.

Provenance

File details

Details for the file antsibull_docs_parser-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for antsibull_docs_parser-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b29490908cd51660cc2b98d6af45b64db938e529f50e84aec416971820013450
MD5 dc0dd482b91d68b6c65383c06d389d43
BLAKE2b-256 ff7981b043730c2705f542832c5267fe5bd9c93559929a3502e9362036a8cdc1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page