Links
AI / Agents
gdtest-user-guide-explicit
A synthetic test package with explicit user guide ordering.
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).
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