#050
gdtest_user_guide_cli
OK
CONFIG
User guide combined with CLI documentation
User guide (F1) combined with CLI documentation. Has user_guide/ with two pages plus a Click CLI. The top nav should show both 'User Guide' and 'Reference'. On the Reference page you should see two functions (process, analyze) and a sidebar switcher to toggle between API and CLI reference.
Build Mode
● Has great-docs.yml
This package ships a pre-supplied config.
The great-docs init step is skipped and
great-docs build uses the spec-defined configuration directly.
Tests specific config options and their rendered output.
Dimensions
A1 B1 C1 D1 E6 F1 G1 H7
A1Flat layoutlayout
B1Explicit __all__exports
C1Functions onlyobjects
D1NumPydocstrings
E6No directivesdirectives
F1Auto-discoveruser_guide
G1README.mdlanding
H7No extrasextras
Source Files
gdtest_user_guide_cli/
__init__.py
"""Package with API, user guide, and CLI."""
__version__ = "0.1.0"
__all__ = ["process", "analyze"]
def process(data: str) -> str:
"""
Process input data.
Parameters
----------
data
Input data string.
Returns
-------
str
Processed output.
"""
return data.upper()
def analyze(data: str) -> dict:
"""
Analyze data and return statistics.
Parameters
----------
data
Input data string.
Returns
-------
dict
Analysis results.
"""
return {"length": len(data)}cli.py
"""CLI interface for gdtest_user_guide_cli."""
try:
import click
except ImportError:
import sys
print("click not installed", file=sys.stderr)
sys.exit(1)
@click.group()
def main():
"""Main CLI entry point for the user-guide-cli tool."""
pass
@main.command()
@click.argument("input_file")
@click.option("--output", "-o", default=None, help="Output file path.")
def run(input_file, output):
"""Run processing on the input file."""
click.echo(f"Processing {input_file}")
@main.command()
@click.argument("input_file")
def stats(input_file):
"""Show statistics for the input file."""
click.echo(f"Stats for {input_file}")user_guide/
01-getting-started.qmd
--- title: Getting Started --- ## Introduction Welcome to gdtest-user-guide-cli. This guide covers basic usage. ## Installation ```bash pip install gdtest-user-guide-cli ```
02-advanced.qmd
--- title: Advanced Usage --- ## Configuration Advanced configuration options for power users. ## Batch Processing Process multiple files at once using the CLI.
README.md
# gdtest-user-guide-cli A test package with user guide and CLI documentation combined.
great-docs.yml
cli: enabled: true