#034
gdtest_user_guide_custom_dir
OK
CONFIG
Custom user guide directory path
User guide lives in docs/guides/ instead of user_guide/. The config specifies user_guide: 'docs/guides'. In the sidebar you should see user guide pages from this custom directory. Two functions (fetch, store) should appear on the Reference page.
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 F5 G1 H7
A1Flat layoutlayout
B1Explicit __all__exports
C1Functions onlyobjects
D1NumPydocstrings
E6No directivesdirectives
F5Custom diruser_guide
G1README.mdlanding
H7No extrasextras
Source Files
docs/
guides/
advanced.qmd
--- title: Advanced --- Advanced topics.
intro.qmd
--- title: Introduction --- Welcome to the custom guide!
gdtest_user_guide_custom_dir/
__init__.py
"""A test package with custom user guide directory."""
__version__ = "0.1.0"
__all__ = ["fetch", "store"]
def fetch(url: str) -> str:
"""
Fetch data from a URL.
Parameters
----------
url
The URL to fetch from.
Returns
-------
str
Fetched data.
"""
return ""
def store(data: str, path: str) -> None:
"""
Store data to a path.
Parameters
----------
data
Data to store.
path
Storage path.
"""
passREADME.md
# gdtest-user-guide-custom-dir A synthetic test package with custom user guide directory.
great-docs.yml
user_guide: docs/guides