gdtest_nested_class — Synthetic Package Details

#026 gdtest_nested_class OK INIT

Nested/inner class handling

Tree class with a nested Node inner class. On the Reference page you should see a 'Classes' section with Tree. The inner Node class should appear under Tree — check whether it renders as a nested entry or a separate top-level item.

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 C11 D1 E6 F6 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C11Nested classesobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_nested_class/

📄 __init__.py

"""A test package with nested classes."""

__version__ = "0.1.0"
__all__ = ["Tree"]


class Tree:
    """
    A tree data structure with a nested Node class.

    Parameters
    ----------
    root_value
        Value for the root node.
    """

    class Node:
        """
        A tree node.

        Parameters
        ----------
        value
            The node value.
        """

        def __init__(self, value):
            self.value = value
            self.children = []

        def add_child(self, value) -> "Tree.Node":
            """
            Add a child node.

            Parameters
            ----------
            value
                The child's value.

            Returns
            -------
            Tree.Node
                The new child node.
            """
            child = Tree.Node(value)
            self.children.append(child)
            return child

        def is_leaf(self) -> bool:
            """
            Check if this node is a leaf.

            Returns
            -------
            bool
                True if no children.
            """
            return len(self.children) == 0

    def __init__(self, root_value=None):
        self.root = self.Node(root_value) if root_value is not None else None

    def depth(self) -> int:
        """
        Calculate the depth of the tree.

        Returns
        -------
        int
            Maximum depth from root to leaf.
        """
        if self.root is None:
            return 0

        def _depth(node):
            if not node.children:
                return 1
            return 1 + max(_depth(c) for c in node.children)

        return _depth(self.root)

    def size(self) -> int:
        """
        Count the total number of nodes.

        Returns
        -------
        int
            Total number of nodes.
        """
        if self.root is None:
            return 0

        def _count(node):
            return 1 + sum(_count(c) for c in node.children)

        return _count(self.root)

📄 README.md

# gdtest-nested-class

A synthetic test package with nested classes.

📄 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:
      - Tree  # 2 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