#024
gdtest_descriptors
OK
INIT
Properties, classmethods, staticmethods
Resource class with @property (name), @classmethod (from_dict), and @staticmethod (validate). On the Reference page you should see a 'Classes' section. Each descriptor should display with its correct decorator label — property, classmethod, or staticmethod markers.
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 C9 D1 E6 F6 G1 H7
A1Flat layoutlayout
B1Explicit __all__exports
C9Descriptorsobjects
D1NumPydocstrings
E6No directivesdirectives
F6No user guideuser_guide
G1README.mdlanding
H7No extrasextras
Source Files
gdtest_descriptors/
__init__.py
"""A test package with various descriptor types."""
__version__ = "0.1.0"
__all__ = ["Resource"]
class Resource:
"""
A managed resource with properties and class/static methods.
Parameters
----------
name
Resource name.
capacity
Maximum capacity.
"""
_instances: list = []
def __init__(self, name: str, capacity: int = 100):
self._name = name
self._capacity = capacity
self._used = 0
@property
def name(self) -> str:
"""
The resource name.
Returns
-------
str
Resource name (read-only).
"""
return self._name
@property
def available(self) -> int:
"""
Available capacity.
Returns
-------
int
Remaining capacity.
"""
return self._capacity - self._used
@available.setter
def available(self, value: int) -> None:
self._used = self._capacity - value
def allocate(self, amount: int) -> bool:
"""
Allocate some capacity.
Parameters
----------
amount
Amount to allocate.
Returns
-------
bool
True if allocation succeeded.
"""
if amount <= self.available:
self._used += amount
return True
return False
@classmethod
def from_dict(cls, data: dict) -> "Resource":
"""
Create a Resource from a dictionary.
Parameters
----------
data
Dictionary with 'name' and optional 'capacity' keys.
Returns
-------
Resource
A new resource instance.
"""
return cls(name=data["name"], capacity=data.get("capacity", 100))
@staticmethod
def validate_name(name: str) -> bool:
"""
Check whether a resource name is valid.
Parameters
----------
name
The name to validate.
Returns
-------
bool
True if valid.
"""
return bool(name) and name.isidentifier()README.md
# gdtest-descriptors A synthetic test package with ``@property``, ``@classmethod``, and ``@staticmethod``.
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:
- Resource # 3 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