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

Update URLs #72

Merged
merged 1 commit into from
Sep 18, 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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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.
add links to subcommands also.
2 changes: 1 addition & 1 deletion mkdocs_click/_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion tests/test_extension.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down