Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump dependency on antsibull-core and use new options #209

Merged
merged 1 commit into from
Sep 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions changelogs/fragments/209-version.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
minor_changes:
- "Antsibull-docs now depends on antsibull-core >= 2.1.0 (https://github.com/ansible-community/antsibull-docs/pull/209)."
bugfixes:
- "When running ``antsibull-docs --version``, the correct version is now shown also for editable installs and other installs that do not allow ``importlib.metadata`` to show the correct version (https://github.com/ansible-community/antsibull-docs/pull/209)."
- "When running ``antsibull-docs --help``, the correct program name is now shown for the ``--version`` option (https://github.com/ansible-community/antsibull-docs/pull/209)."
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ classifiers = [
requires-python = ">=3.9"
dependencies = [
"ansible-pygments",
"antsibull-core >= 2.0.0, < 3.0.0",
"antsibull-core >= 2.1.0, < 3.0.0",
"antsibull-docs-parser >= 1.0.0, < 2.0.0",
"asyncio-pool",
"docutils",
Expand Down
4 changes: 4 additions & 0 deletions src/antsibull_docs/cli/antsibull_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
from antsibull_core.config import ConfigError, load_config # noqa: E402
from antsibull_core.filesystem import UnableToCheck, writable_via_acls # noqa: E402

import antsibull_docs # noqa: E402

from ..constants import DOCUMENTABLE_PLUGINS # noqa: E402
from ..docs_parsing.fqcn import is_fqcn # noqa: E402
from ..schemas.app_context import DocsAppContext # noqa: E402
Expand Down Expand Up @@ -327,6 +329,8 @@ def parse_args(program_name: str, args: list[str]) -> argparse.Namespace:
parser = get_toplevel_parser(
prog=program_name,
package="antsibull_docs",
package_version=antsibull_docs.__version__,
program_name="antsibull-docs",
description="Script to manage generated documentation for ansible",
)
subparsers = parser.add_subparsers(
Expand Down