← GDG /

#136 gdtest_sphinx_meth_role

#136 gdtest_sphinx_meth_role OK INIT
:py:meth: cross-reference roles between methods
Docstrings contain :py:meth:`MyClass.method` cross-reference roles. Post-render should strip :py:meth: prefix and add (). One class with methods referencing each other.
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

L13
L13:py:meth: roledocstring

Source Files

📁 gdtest_sphinx_meth_role/
📄 __init__.py
"""Package demonstrating :py:meth: cross-reference roles."""

__version__ = "0.1.0"
__all__ = ["Pipeline"]


class Pipeline:
    """
    A processing pipeline that manages a sequence of steps.

    Parameters
    ----------
    name
        The name of this pipeline.
    """

    def __init__(self, name: str = "default"):
        self.name = name
        self._steps: list = []

    def add_step(self, step: str) -> None:
        """
        Add a step to the pipeline.

        Call :py:meth:`Pipeline.run` to execute.

        Parameters
        ----------
        step
            The step identifier to add.
        """
        self._steps.append(step)

    def remove_step(self, step: str) -> bool:
        """
        Remove a step from the pipeline.

        Parameters
        ----------
        step
            The step identifier to remove.

        Returns
        -------
        bool
            True if the step was found and removed.
        """
        if step in self._steps:
            self._steps.remove(step)
            return True
        return False

    def run(self) -> list:
        """
        Execute all steps in the pipeline.

        Use :py:meth:`Pipeline.reset` to clear after running.

        Returns
        -------
        list
            Results from each step execution.
        """
        return [f"executed:{s}" for s in self._steps]

    def reset(self) -> None:
        """
        Clear all steps from the pipeline.

        After calling this, use :py:meth:`Pipeline.add_step` to add
        new steps.

        Returns
        -------
        None
        """
        self._steps.clear()
📄 README.md
# gdtest-sphinx-meth-role

A synthetic test package testing ``:py:meth:`` 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:
      - Pipeline  # 4 method(s)

# 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