Links

View on PyPI

AI / Agents

Skills
llms.txt
llms-full.txt

gdtest-sphinx-mixed-roles

A synthetic test package testing mixed Sphinx cross-reference roles.

Docstrings mix :py:func:, :py:class:, :py:exc:, :py:meth:, and :py:attr: roles in the same module. All should be translated correctly by post-render.

Source files

📁 gdtest_sphinx_mixed_roles/

📄 __init__.py

"""Package demonstrating mixed Sphinx cross-reference roles."""

__version__ = "0.1.0"
__all__ = ["Registry", "register", "lookup", "validate_entry"]


class Registry:
    """
    A registry that maps names to types.

    Use :py:func:`register` to add entries, or call
    :py:meth:`Registry.get` directly.

    Parameters
    ----------
    strict
        If True, raises :py:exc:`KeyError` on missing lookups.
    """

    def __init__(self, strict: bool = False):
        self.strict = strict
        self._entries: dict = {}

    def get(self, name: str) -> type:
        """
        Get a registered type by name.

        Checks :py:attr:`Registry.strict` to decide behavior on
        missing keys. Raises :py:exc:`KeyError` if strict mode
        is enabled and the name is not found.

        Parameters
        ----------
        name
            The registered name to look up.

        Returns
        -------
        type
            The registered type.

        Raises
        ------
        KeyError
            If the name is not registered and strict mode is on.
        """
        if name in self._entries:
            return self._entries[name]
        if self.strict:
            raise KeyError(name)
        return type(None)

    def add(self, name: str, cls: type) -> None:
        """
        Add a type to the registry.

        See also :py:func:`register` for the module-level helper.

        Parameters
        ----------
        name
            The name to register under.
        cls
            The type to register.
        """
        self._entries[name] = cls

    @property
    def names(self) -> list:
        """
        List all registered names.

        Returns
        -------
        list
            A list of registered name strings.
        """
        return list(self._entries.keys())


_default_registry = Registry()


def register(name: str, cls: type) -> None:
    """
    Register a type in the default :py:class:`Registry`.

    Calls :py:meth:`Registry.add` on the default instance.

    Parameters
    ----------
    name
        The name to register under.
    cls
        The type to register.
    """
    _default_registry.add(name, cls)


def lookup(name: str) -> type:
    """
    Look up a type in the default :py:class:`Registry`.

    Delegates to :py:meth:`Registry.get`. May raise
    :py:exc:`KeyError` in strict mode.

    Parameters
    ----------
    name
        The name to look up.

    Returns
    -------
    type
        The registered type.
    """
    return _default_registry.get(name)


def validate_entry(entry: dict) -> bool:
    """
    Validate a registry entry dict.

    An entry must have ``"name"`` and ``"cls"`` keys. The ``"cls"``
    value should be passable to :py:func:`register`. If invalid,
    raises :py:exc:`ValueError`.

    Checks :py:attr:`Registry.strict` on the default registry
    to determine validation level.

    Parameters
    ----------
    entry
        A dict with ``"name"`` and ``"cls"`` keys.

    Returns
    -------
    bool
        True if the entry is valid.

    Raises
    ------
    ValueError
        If the entry dict is missing required keys.
    """
    if "name" not in entry or "cls" not in entry:
        raise ValueError("Entry must have 'name' and 'cls' keys")
    return True

📄 README.md

# gdtest-sphinx-mixed-roles

A synthetic test package testing mixed Sphinx cross-reference roles.

📄 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: Classes
    desc: Main classes provided by the package
    contents:
      - Registry  # 2 method(s)

  - title: Functions
    desc: Utility functions
    contents:
      - lookup
      - register
      - validate_entry

# 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