#171
gdtest_sec_with_ug
OK
CONFIG
Custom Examples section combined with auto-discovered user guide.
Custom section (Examples) combined with auto-discovered user guide. Both should appear as separate nav sections without conflict.
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
N1 M1
N1Examples sectionsections
M1Auto-discover UGuser_guide
Source Files
examples/
demo.qmd
--- title: Demo --- # Demo A demonstration of the package features.
gdtest_sec_with_ug/
__init__.py
"""Test package for custom section with user guide.""" from .core import guide_user, run_example __all__ = ["guide_user", "run_example"]
core.py
"""Core run_example/guide_user functions."""
def run_example() -> str:
"""Run the example and return a result message.
Returns
-------
str
A message indicating the example ran successfully.
Examples
--------
>>> run_example()
'Example complete'
"""
return "Example complete"
def guide_user(topic: str) -> str:
"""Guide the user through a specific topic.
Parameters
----------
topic : str
The topic to guide the user through.
Returns
-------
str
A guidance message for the topic.
Examples
--------
>>> guide_user("setup")
'Guide: setup'
"""
return f"Guide: {topic}"user_guide/
intro.qmd
--- title: Introduction --- # Introduction An introduction to the project.
usage.qmd
--- title: Usage Guide --- # Usage Guide How to use the project effectively.
README.md
# gdtest-sec-with-ug Test custom section with auto-discovered user guide.
great-docs.yml
sections:
- title: Examples
dir: examples