gdtest_github_contrib — Synthetic Package Details

#042 gdtest_github_contrib OK INIT

CONTRIBUTING.md in .github/ subdirectory only

CONTRIBUTING.md lives in .github/ (not the project root). The sidebar should still show a Contributing link. Clicking it should display the contributing content. The Reference page should show two functions (process, validate). The key test: .github/ fallback path for contributing.

View Site → Build Log 🧪 Test Coverage

Build Mode

○ No great-docs.yml

This package has no pre-supplied config. It tests the full great-docs init → great-docs build pipeline from scratch, relying entirely on auto-detection of the package layout, docstring style, and exports.

Dimensions

A1 B1 C1 D1 E6 F6 G1 H3

A1Flat layoutlayout

B1Explicit __all__exports

C1Functions onlyobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H3CONTRIBUTING.mdextras

Source Files

📁 .github/

📄 CONTRIBUTING.md

# Contributing to gdtest-github-contrib

Thank you for considering contributing!

## Getting Started

1. Fork the repo
2. Create a branch
3. Make your changes
4. Submit a PR

## Code of Conduct

Please be respectful.

📁 gdtest_github_contrib/

📄 __init__.py

"""A package with contributing guide in .github/ directory."""

__version__ = "0.1.0"
__all__ = ["process", "validate"]


def process(data: list) -> list:
    """
    Process incoming data.

    Parameters
    ----------
    data
        The data to process.

    Returns
    -------
    list
        Processed data.
    """
    return data


def validate(item: str) -> bool:
    """
    Validate a single item.

    Parameters
    ----------
    item
        The item to validate.

    Returns
    -------
    bool
        True if valid.
    """
    return bool(item)

📄 README.md

# gdtest-github-contrib

A test package with .github/CONTRIBUTING.md.

📄 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:
      - process
      - validate

# 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