#268
gdtest_code_cells
OK
INIT
Executable code cells in docstring examples
Executable code cells in docstring examples. Tests that ```{python} blocks are preserved as executable Quarto cells, #| directives like eval: false are honored, and static ```python blocks remain static.
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 H7
A1Flat layoutlayout
B1Explicit __all__exports
C1Functions onlyobjects
D1NumPydocstrings
E6No directivesdirectives
F6No user guideuser_guide
G1README.mdlanding
H7No extrasextras
Source Files
gdtest_code_cells/
__init__.py
"""Test package for executable code cells in API reference."""
__version__ = "0.1.0"
__all__ = ["add", "multiply", "greet", "fibonacci"]
def add(a: int, b: int) -> int:
"""
Add two numbers.
This function uses an executable code cell that should be
run by Quarto during the build.
Parameters
----------
a
First number.
b
Second number.
Returns
-------
int
The sum of a and b.
Examples
--------
```{python}
from gdtest_code_cells import add
add(2, 3)
```
"""
return a + b
def multiply(a: int, b: int) -> int:
"""
Multiply two numbers.
This function uses an executable code cell with
``#| eval: false`` so the code is displayed but not run.
Parameters
----------
a
First number.
b
Second number.
Returns
-------
int
The product of a and b.
Examples
--------
```{python}
#| eval: false
from gdtest_code_cells import multiply
result = multiply(4, 5)
print(f"4 x 5 = {result}")
```
"""
return a * b
def greet(name: str) -> str:
"""
Greet someone by name.
This function uses a static code block (no curly braces)
that should NOT be executed by Quarto.
Parameters
----------
name
The name of the person to greet.
Returns
-------
str
A greeting string.
Examples
--------
```python
from gdtest_code_cells import greet
greet("World")
```
"""
return f"Hello, {name}!"
def fibonacci(n: int) -> list[int]:
"""
Generate the first n Fibonacci numbers.
This function demonstrates multiple code blocks: one
executable and one with ``#| eval: false``.
Parameters
----------
n
How many Fibonacci numbers to generate.
Returns
-------
list[int]
The first n Fibonacci numbers.
Examples
--------
An executed cell showing output:
```{python}
from gdtest_code_cells import fibonacci
fibonacci(8)
```
A non-executed cell with multiple hash-pipe options:
```{python}
#| eval: false
#| echo: true
# Generate a large sequence
big = fibonacci(100)
print(f"The 100th Fibonacci number is {big[-1]}")
```
"""
if n <= 0:
return []
fibs = [0, 1]
while len(fibs) < n:
fibs.append(fibs[-1] + fibs[-2])
return fibs[:n]README.md
# gdtest-code-cells
Synthetic test for executable code cells in docstring examples.
## Purpose
Tests that Great Docs preserves Quarto executable cell syntax:
- ```` ```{python} ```` — cell is executed, output shown
- ```` ```{python}\n#| eval: false ```` — code shown, not executed
- ```` ```python ```` — static display, no executiongreat-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:
- add
- fibonacci
- greet
- multiply
# 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