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.

Sign up for GitHub

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

Make usage heading bold #14

Closed
wants to merge 5 commits into from
+8 −8
Closed

Make usage heading bold #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7b2fd41
Make usage heading bold
yudai-nkt Nov 20, 2020
8ed502b
Update test
yudai-nkt Nov 20, 2020
17b6c0f
Merge branch 'master' into usage-in-bold
Dec 9, 2020
38a27d9
Use underscores in stead of asterisk
yudai-nkt Dec 12, 2020
462c948
Merge branch 'usage-in-bold' of ssh://github.com/yudai-nkt/mkdocs-cli…
yudai-nkt Dec 12, 2020
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
2 changes: 1 addition & 1 deletion mkdocs_click/_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def _make_usage(ctx: click.Context) -> Iterator[str]:
full_path.reverse()
usage_snippet = " ".join(full_path) + usage

yield "Usage:"
yield "__Usage:__"
yield ""
yield "```"
yield usage_snippet
Expand Down
8 changes: 4 additions & 4 deletions tests/app/expected.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Main entrypoint for this dummy program

Usage:
**Usage:**

```
cli [OPTIONS] COMMAND [ARGS]...
Expand All @@ -12,7 +12,7 @@ cli [OPTIONS] COMMAND [ARGS]...

The bar command

Usage:
**Usage:**

```
cli bar [OPTIONS] COMMAND [ARGS]...
Expand All @@ -22,7 +22,7 @@ cli bar [OPTIONS] COMMAND [ARGS]...

Simple program that greets NAME for a total of COUNT times.

Usage:
__Usage:__

```
cli bar hello [OPTIONS]
Expand All @@ -37,7 +37,7 @@ Options:

## foo

Usage:
__Usage:__

```
cli foo [OPTIONS]
Expand Down
6 changes: 3 additions & 3 deletions tests/unit/test_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def hello():

Hello, world!

Usage:
__Usage:__

```
hello [OPTIONS]
Expand Down Expand Up @@ -74,7 +74,7 @@ def test_custom_multicommand():

Multi help

Usage:
__Usage:__

```
multi [OPTIONS] COMMAND [ARGS]...
Expand All @@ -84,7 +84,7 @@ def test_custom_multicommand():

Hello, world!

Usage:
__Usage:__

```
multi hello [OPTIONS]
Expand Down