User Guide

This is where you explain the "what" and "how" of your project's features.

Configuration

Explain how users can configure the project, including examples of the pyproject.toml or config.toml file.

CLI Commands

If your project has a command-line interface, document each command, its arguments, and options. Using a tool like mkdocs-typer2 can automate this.

::: mkdocs-typer2
:module: jm_python_template.main
:name: mkdocs-typer2
:pretty: true

app

Demo CLI

Usage

app [OPTIONS] COMMAND [ARGS]...

Arguments

No arguments available

Options

Name	Description	Required	Default
--install-completion	Install completion for the current shell.	No	-
--show-completion	Show completion for the current shell, to copy it or customize the installation.	No	-
--help	Show this message and exit.	No	-

Commands

Name	Description
comma	Main function of the application.
docs	Generate docs for a project.
hello	Some docstring content.

Sub Commands

app comma

Main function of the application.

Args: name (str): The name to greet. version (Optional): Whether to print the version.

Returns: None

Usage

app comma [OPTIONS]

Arguments

No arguments available

Options

Name	Description	Required	Default
--name TEXT	[default: World]	No	-
--help	Show this message and exit.	No	-

app docs

Generate docs for a project.

Usage

app docs [OPTIONS]

Arguments

No arguments available

Options

Name	Description	Required	Default
--name TEXT	The name of the project	Yes	-
--help	Show this message and exit.	No	-

app hello

Some docstring content.

Usage

app hello [OPTIONS] NAME

Arguments

Name	Description	Required
NAME	The name of the person to greet	Yes

Options

Name	Description	Required	Default
--color TEXT	The color of the output	No	-
--help	Show this message and exit.	No	-

Advanced Usage

Describe more complex use cases or features.