| Name | antsibull-docs-parser JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | Python library for processing Ansible documentation markup |
| upload_time | 2024-08-25 07:36:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6.1 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!--
Copyright (c) Ansible Project
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
SPDX-FileCopyrightText: 2023, Ansible Project
-->
# antsibull-docs-parser - Python library for processing Ansible documentation markup
[](https://matrix.to/#/#antsibull:ansible.com)
[](https://github.com/ansible-community/antsibull-docs-parser/actions/workflows/nox.yml)
[](https://codecov.io/gh/ansible-community/antsibull-docs-parser)
[](https://api.reuse.software/info/github.com/ansible-community/antsibull-docs-parser)
This is a Python library for processing Ansible documentation markup. It is named after [antsibull-docs](https://github.com/ansible-community/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](https://github.com/ansible-community/antsibull-docs-ts).
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "antsibull-docs-parser",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6.1",
"maintainer_email": "Felix Fontein <felix@fontein.de>, Maxwell G <maxwell@gtmx.me>",
"keywords": null,
"author": null,
"author_email": "Felix Fontein <felix@fontein.de>",
"download_url": "https://files.pythonhosted.org/packages/3b/da/479125fd5478ce87e671bf0457b3b8b0dc9fc6ea0da1087900461c70da0e/antsibull_docs_parser-1.1.0.tar.gz",
"platform": null,
"description": "<!--\nCopyright (c) Ansible Project\nGNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)\nSPDX-License-Identifier: GPL-3.0-or-later\nSPDX-FileCopyrightText: 2023, Ansible Project\n-->\n\n# antsibull-docs-parser - Python library for processing Ansible documentation markup\n[](https://matrix.to/#/#antsibull:ansible.com)\n[](https://github.com/ansible-community/antsibull-docs-parser/actions/workflows/nox.yml)\n[](https://codecov.io/gh/ansible-community/antsibull-docs-parser)\n[](https://api.reuse.software/info/github.com/ansible-community/antsibull-docs-parser)\n\nThis is a Python library for processing Ansible documentation markup. It is named after [antsibull-docs](https://github.com/ansible-community/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.\n\n## Development\n\nInstall 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.\n\nTo run specific tests:\n1. `nox -e test` to only run unit tests;\n2. `nox -e lint` to run all linters and formatters at once;\n3. `nox -e formatters` to run `isort` and `black`;\n4. `nox -e codeqa` to run `flake8`, `pylint`, `reuse lint`, and `antsibull-changelog lint`;\n5. `nox -e typing` to run `mypy` and `pyre`;\n6. `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](https://github.com/ansible-community/antsibull-docs-ts).\n\n## Releasing a new version\n\n1. Run `nox -e bump -- <version> <release_summary_message>`. This:\n * Bumps the package version in `src/antsibull_docs_parser/__init__.py`.\n * Creates `changelogs/fragments/<version>.yml` with a `release_summary` section.\n * Runs `antsibull-changelog release` and adds the changed files to git.\n * Commits with message `Release <version>.` and runs `git tag -a -m 'antsibull-docs-parser <version>' <version>`.\n * Runs `hatch build --clean`.\n2. Run `git push` to the appropriate remotes.\n3. Once CI passes on GitHub, run `nox -e publish`. This:\n * Runs `hatch publish`;\n * Bumps the version to `<version>.post0`;\n * Adds the changed file to git and run `git commit -m 'Post-release version bump.'`;\n4. Run `git push --follow-tags` to the appropriate remotes and create a GitHub release.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python library for processing Ansible documentation markup",
"version": "1.1.0",
"project_urls": {
"Bug tracker": "https://github.com/ansible-community/antsibull-docs-parser/issues",
"Changelog": "https://github.com/ansible-community/antsibull-docs-parser/tree/main/CHANGELOG.md",
"Code of Conduct": "https://docs.ansible.com/ansible/latest/community/code_of_conduct.html",
"Source code": "https://github.com/ansible-community/antsibull-docs-parser/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ff7981b043730c2705f542832c5267fe5bd9c93559929a3502e9362036a8cdc1",
"md5": "dc0dd482b91d68b6c65383c06d389d43",
"sha256": "b29490908cd51660cc2b98d6af45b64db938e529f50e84aec416971820013450"
},
"downloads": -1,
"filename": "antsibull_docs_parser-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc0dd482b91d68b6c65383c06d389d43",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.1",
"size": 33827,
"upload_time": "2024-08-25T07:36:59",
"upload_time_iso_8601": "2024-08-25T07:36:59.580401Z",
"url": "https://files.pythonhosted.org/packages/ff/79/81b043730c2705f542832c5267fe5bd9c93559929a3502e9362036a8cdc1/antsibull_docs_parser-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3bda479125fd5478ce87e671bf0457b3b8b0dc9fc6ea0da1087900461c70da0e",
"md5": "c6dac9e0c71c9c8e633c56c110660b1f",
"sha256": "9b94400918343677119c38344bf3bd867a937259f8d09fddc68deae2741ba056"
},
"downloads": -1,
"filename": "antsibull_docs_parser-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c6dac9e0c71c9c8e633c56c110660b1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.1",
"size": 55192,
"upload_time": "2024-08-25T07:36:57",
"upload_time_iso_8601": "2024-08-25T07:36:57.882096Z",
"url": "https://files.pythonhosted.org/packages/3b/da/479125fd5478ce87e671bf0457b3b8b0dc9fc6ea0da1087900461c70da0e/antsibull_docs_parser-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 07:36:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansible-community",
"github_project": "antsibull-docs-parser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "antsibull-docs-parser"
}
