#318
gdtest_no_breadcrumbs
OK
CONFIG
API reference pages with site-wide breadcrumbs disabled
Mirror gdtest_minimal with two functions and NumPy docstrings. Disable breadcrumbs site-wide through the `site` passthrough. Reference object pages and the index must still show the API title bar and exactly one h1.
Build Mode
● Has great-docs.yml
This package ships a pre-supplied config.
The great-docs init step is skipped and
great-docs build uses the spec-defined configuration directly.
Tests specific config options and their rendered output.
Dimensions
Q1
Q1Cosmo themetheme
Source Files
gdtest_no_breadcrumbs/
__init__.py
"""Synthetic package with breadcrumbs disabled site-wide"""
__version__ = "0.1.0"
__all__ = ["greet", "add"]
def greet(name: str) -> str:
"""
Return a greeting for a name
Parameters
----------
name
Name to greet.
Returns
-------
Greeting string.
"""
return f"Hello, {name}!"
def add(a: int, b: int) -> int:
"""
Add two numbers
Parameters
----------
a
First number.
b
Second number.
Returns
-------
Sum of `a` and `b`.
"""
return a + bREADME.md
# gdtest-no-breadcrumbs
Exercise reference pages with breadcrumbs disabled site-wide.
## Installation
```bash
pip install gdtest-no-breadcrumbs
```
## Usage
```python
from gdtest_no_breadcrumbs import greet, add
greet("World")
add(1, 2)
```great-docs.yml
site: bread-crumbs: false