#165
gdtest_sec_tutorials
OK
CONFIG
Custom 'Tutorials' section via sections config.
Custom 'Tutorials' section. tutorials/ dir with step-by-step pages. Should appear as a separate nav section.
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
N2
N2Tutorials sectionsections
Source Files
gdtest_sec_tutorials/
__init__.py
"""Test package for custom Tutorials section.""" from .core import learn, practice __all__ = ["learn", "practice"]
core.py
"""Core learn/practice functions."""
def learn(topic: str) -> str:
"""Learn about a specific topic.
Parameters
----------
topic : str
The topic to learn about.
Returns
-------
str
A summary of the topic.
Examples
--------
>>> learn("python")
'Learned about python'
"""
return f"Learned about {topic}"
def practice(exercise: int) -> bool:
"""Practice a specific exercise.
Parameters
----------
exercise : int
The exercise number to practice.
Returns
-------
bool
True if the exercise was completed successfully.
Examples
--------
>>> practice(1)
True
"""
return Truetutorials/
getting-started.qmd
--- title: Getting Started --- # Getting Started A beginner-friendly tutorial to help you get started.
intermediate.qmd
--- title: Intermediate Tutorial --- # Intermediate Tutorial A tutorial covering intermediate-level concepts.
README.md
# gdtest-sec-tutorials Test custom Tutorials section.
great-docs.yml
sections:
- title: Tutorials
dir: tutorials