#157
gdtest_ug_explicit_order
OK
CONFIG
Explicit user guide ordering via config with titled sections and contents lists.
User guide ordering defined explicitly in great-docs.yml config. Pages appear in config-specified order, not alphabetical.
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
M9
M9Explicit orderinguser_guide
Source Files
gdtest_ug_explicit_order/
__init__.py
"""Test package for explicit user guide ordering."""
core.py
"""Core begin/dive functions."""
def begin() -> None:
"""Begin the initialization process.
Returns
-------
None
Examples
--------
>>> begin()
"""
pass
def dive(topic: str) -> str:
"""Dive deep into a specific topic.
Parameters
----------
topic : str
The topic to explore in depth.
Returns
-------
str
A detailed explanation of the topic.
Examples
--------
>>> dive("internals")
'Deep dive into internals'
"""
return f"Deep dive into {topic}"user_guide/
install.qmd
--- title: Installation --- # Installation How to install the package and its dependencies.
internals.qmd
--- title: Internals --- # Internals A deep dive into the internal architecture.
quickstart.qmd
--- title: Quickstart --- # Quickstart Get started quickly with a minimal example.
great-docs.yml
user_guide:
- title: First Steps
contents:
- quickstart.qmd
- install.qmd
- title: Deep Dive
contents:
- internals.qmd