#033
gdtest_user_guide_explicit
OK
CONFIG
Explicit user guide ordering via config
User guide order is defined in great-docs.yml: 'Get Started' section (Welcome → quickstart.qmd) then 'Advanced' section (advanced.qmd). The sidebar should show exactly this ordering, ignoring filename sort. 'Welcome' should use custom text (not the filename).
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
A1 B1 C1 D1 E6 F4 G1 H7
A1Flat layoutlayout
B1Explicit __all__exports
C1Functions onlyobjects
D1NumPydocstrings
E6No directivesdirectives
F4Explicit orderinguser_guide
G1README.mdlanding
H7No extrasextras
Source Files
gdtest_user_guide_explicit/
__init__.py
"""A test package with explicit user guide ordering."""
__version__ = "0.1.0"
__all__ = ["run", "stop"]
def run() -> None:
"""
Run the process.
Returns
-------
None
"""
pass
def stop() -> None:
"""
Stop the process.
Returns
-------
None
"""
passuser_guide/
advanced.qmd
--- title: Advanced Usage --- Advanced topics.
intro.qmd
--- title: Introduction --- Welcome to the project!
quickstart.qmd
--- title: Quick Start --- Get started quickly.
README.md
# gdtest-user-guide-explicit A synthetic test package with explicit user guide ordering.
great-docs.yml
user_guide:
- section: Get Started
contents:
- text: Welcome
href: intro.qmd
- quickstart.qmd
- section: Advanced
contents:
- advanced.qmd