From 2ccec401387b2e8201b89bf2ebaf53ae5ed7904f Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Mon, 18 Sep 2023 17:48:24 +0200 Subject: [PATCH] Update URLs --- README.md | 6 +++--- mkdocs_click/_docs.py | 2 +- tests/test_extension.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 47a9424..e93e3ca 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # mkdocs-click -![Tests](https://github.com/DataDog/mkdocs-click/workflows/Tests/badge.svg?branch=master) +![Tests](https://github.com/mkdocs/mkdocs-click/workflows/CI/badge.svg?branch=master) ![Python versions](https://img.shields.io/pypi/pyversions/mkdocs-click.svg) -[![Package version](https://badge.fury.io/py/mkdocs-click.svg)](https://pypi.org/project/mkdocs-click) +[![PyPI](https://img.shields.io/pypi/v/mkdocs-click)](https://pypi.org/project/mkdocs-click/) An MkDocs extension to generate documentation for Click command line applications. @@ -137,4 +137,4 @@ Options: - `remove_ascii_art`: _(Optional, default: `False`)_ When docstrings begin with the escape character `\b`, all text will be ignored until the next blank line is encountered. - `show_hidden`: _(Optional, default: `False`)_ Show commands and options that are marked as hidden. - `list_subcommands`: _(Optional, default: `False`)_ List subcommands of a given command. If _attr_list_ is installed, -add links to subcommands also. \ No newline at end of file +add links to subcommands also. diff --git a/mkdocs_click/_docs.py b/mkdocs_click/_docs.py index 336393a..d9a26bc 100644 --- a/mkdocs_click/_docs.py +++ b/mkdocs_click/_docs.py @@ -138,7 +138,7 @@ def _make_title_full_command_path(ctx: click.Context, depth: int) -> Iterator[st We do this because a TOC naturally conveys the hierarchy, whereas headings and permalinks should be namespaced to convey the hierarchy. - See: https://github.com/DataDog/mkdocs-click/issues/35 + See: https://github.com/mkdocs/mkdocs-click/issues/35 """ text = ctx.command_path # 'git commit' permalink = slugify(ctx.command_path, "-") # 'git-commit' diff --git a/tests/test_extension.py b/tests/test_extension.py index e796f7a..8ecf2c9 100644 --- a/tests/test_extension.py +++ b/tests/test_extension.py @@ -110,7 +110,7 @@ def test_enhanced_titles(): """ If `attr_list` extension is registered, section titles are enhanced with full command paths. - See: https://github.com/DataDog/mkdocs-click/issues/35 + See: https://github.com/mkdocs/mkdocs-click/issues/35 """ md = Markdown(extensions=["attr_list"]) # Register our extension as a second step, so that we see `attr_list`.