Getting Started
Welcome to the project! This is the first user guide page and will become the site landing page in blended homepage mode.
Installation
Install with pip:
pip install gdtest-homepage-ugSource files
gdtest_homepage_ug/
__init__.py
"""A test package for blended homepage mode."""
__version__ = "0.1.0"
__all__ = ["greet", "farewell"]
def greet(name: str) -> str:
"""
Greet someone.
Parameters
----------
name
The name to greet.
Returns
-------
str
A greeting string.
"""
return f"Hello, {name}!"
def farewell(name: str) -> str:
"""
Say farewell to someone.
Parameters
----------
name
The name to bid farewell.
Returns
-------
str
A farewell string.
"""
return f"Goodbye, {name}!"user_guide/
00-getting-started.qmd
--- title: Getting Started --- # Getting Started Welcome to the project! This is the first user guide page and will become the site landing page in blended homepage mode. ## Installation Install with pip: ```bash pip install gdtest-homepage-ug ```
01-configuration.qmd
--- title: Configuration --- # Configuration Learn how to configure the package. ## Basic Setup Create a config file and set your options.
02-advanced.qmd
--- title: Advanced Usage --- # Advanced Usage Explore advanced topics and customization.
README.md
# gdtest-homepage-ug A synthetic test package for blended homepage mode.
great-docs.yml
homepage: user_guide