gdtest-badge-readme

A test package with a complex README featuring badges, tables, and nested lists.

Features

Feature	Status	Notes
Badges	Supported	Shields.io badges
Tables	Supported	Standard Markdown tables
Lists	Supported	Including nested lists

Quick Start

Install the package:
```
pip install gdtest-badge-readme
```

Import and use:

from gdtest_badge_readme import greet
greet("World")

Advanced Topics

Topic A
- Sub-topic A.1
- Sub-topic A.2
  - Detail A.2.1
Topic B
- Sub-topic B.1

Links

This README tests complex Markdown rendering.

README.md with shields.io badges, images, and complex Markdown (tables, footnotes, nested lists). The landing page should render badges as images, tables as HTML tables, and links should be clickable. Key test: complex Markdown in README.

Source files

📁 gdtest_badge_readme/

📄 __init__.py

"""Package with a badge-heavy README."""

__version__ = "0.1.0"
__all__ = ["greet"]


def greet(name: str) -> str:
    """
    Greet someone.

    Parameters
    ----------
    name
        The name.

    Returns
    -------
    str
        Greeting.
    """
    return f"Hello, {name}!"

📄 README.md

# gdtest-badge-readme

[![PyPI version](https://img.shields.io/badge/pypi-v0.1.0-blue.svg)](https://pypi.org/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://python.org)
[![CI Status](https://img.shields.io/badge/CI-passing-brightgreen.svg)](https://github.com/)

A test package with a complex README featuring badges, tables, and nested lists.

## Features

| Feature | Status | Notes |
|---------|--------|-------|
| Badges | Supported | Shields.io badges |
| Tables | Supported | Standard Markdown tables |
| Lists | Supported | Including nested lists |

## Quick Start

1. Install the package:
   ```bash
   pip install gdtest-badge-readme
   ```
2. Import and use:
   ```python
   from gdtest_badge_readme import greet
   greet("World")
   ```

## Advanced Topics

- **Topic A**
  - Sub-topic A.1
  - Sub-topic A.2
    - Detail A.2.1
- **Topic B**
  - Sub-topic B.1

## Links

- [Documentation](https://example.com/docs)
- [Source Code](https://github.com/example/repo)
- [Issue Tracker](https://github.com/example/repo/issues)

---

*This README tests complex Markdown rendering.*

📄 great-docs.yml generated

# Great Docs Configuration
# See https://posit-dev.github.io/great-docs/user-guide/configuration.html

# Module Name (optional)
# ----------------------
# Set this if your importable module name differs from the project name.
# Example: project 'py-yaml12' with module name 'yaml12'
# module: yaml12

# Docstring Parser
# ----------------
# The docstring format used in your package (numpy, google, or sphinx)
parser: numpy

# Dynamic Introspection
# ---------------------
# Use runtime introspection for more accurate documentation (default: true)
# Set to false if your package has cyclic alias issues (e.g., PyO3/Rust bindings)
dynamic: true

# API Discovery Settings
# ----------------------
# Exclude items from auto-documentation
# exclude:
#   - InternalClass
#   - helper_function

# Logo & Favicon
# ---------------
# Point to a single logo file (replaces the text title in the navbar):
# logo: assets/logo.svg
#
# For light/dark variants:
# logo:
#   light: assets/logo-light.svg
#   dark: assets/logo-dark.svg
#
# To show the text title alongside the logo, add: show_title: true

# Funding / Copyright Holder
# --------------------------
# Credit the organization that funds or holds copyright for this package.
# Displays in sidebar and footer. Homepage and ROR provide links.
# funding:
#   name: "Posit Software, PBC"
#   roles:
#     - Copyright holder
#     - funder
#   homepage: https://posit.co
#   ror: https://ror.org/03wc8by49

# API Reference Structure
# -----------------------
# Customize the sections below to organize your API documentation.
# - Reorder items within a section to change their display order
# - Move items between sections or create new sections
# - Use 'members: false' to exclude methods from documentation
# - Add 'desc:' to sections for descriptions

reference:
  - title: Functions
    desc: Utility functions
    contents:
      - greet

# Site URL
# --------
# Canonical address of the deployed documentation site.
# Required for subdirectory deployments, skills page install commands,
# .well-known/ discovery, and sitemaps.
# site_url: "https://your-org.github.io/your-package/"

# Site Settings
# -------------
# site:
#   theme: flatly              # Quarto theme (default: flatly)
#   toc: true                  # Show table of contents (default: true)
#   toc-depth: 2               # TOC heading depth (default: 2)
#   toc-title: On this page    # TOC title (default: "On this page")

# Jupyter Kernel
# --------------
# Jupyter kernel to use for executing code cells in .qmd files.
# This is set at the project level so it applies to all pages, including
# auto-generated API reference pages. Can be overridden in individual .qmd
# file frontmatter if needed for special cases.
jupyter: python3

# CLI Documentation
# -----------------
# cli:
#   enabled: true              # Enable CLI documentation
#   module: my_package.cli     # Module containing Click commands
#   name: cli                  # Name of the Click command object