← GDG /

#173 gdtest_sec_deep

#173 gdtest_sec_deep OK CONFIG
Custom section with nested subdirectories.
Custom section with nested subdirectories: tutorials/beginner/ and tutorials/advanced/. Deep structure within a custom section.
View Site → Build Log ๐Ÿงช Test Coverage

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_deep/
๐Ÿ“„ __init__.py
"""Test package for custom section with nested subdirectories."""

from .core import learn, test_knowledge

__all__ = ["learn", "test_knowledge"]
๐Ÿ“„ core.py
"""Core learn/test_knowledge 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 learned topic.

    Examples
    --------
    >>> learn("python")
    'Learned: python'
    """
    return f"Learned: {topic}"


def test_knowledge(quiz: str) -> bool:
    """Test knowledge on a given quiz topic.

    Parameters
    ----------
    quiz : str
        The quiz topic to test.

    Returns
    -------
    bool
        True if the quiz was passed.

    Examples
    --------
    >>> test_knowledge("basics")
    True
    """
    return True
๐Ÿ“ tutorials/
๐Ÿ“ advanced/
๐Ÿ“„ patterns.qmd
---
title: Advanced Patterns
---

# Advanced Patterns

Explore advanced design patterns and techniques.
๐Ÿ“ beginner/
๐Ÿ“„ basics.qmd
---
title: Basics
---

# Basics

Learn the basic concepts and patterns.
๐Ÿ“„ hello.qmd
---
title: Hello World
---

# Hello World

A beginner tutorial for getting started.
๐Ÿ“„ README.md
# gdtest-sec-deep

Test custom section with nested subdirectories.
๐Ÿ“„ great-docs.yml
sections:
  - title: Tutorials
    dir: tutorials