Skip to content

docs: improve cookbook Sphinx tag #2082

@lidavidm

Description

@lidavidm
  • Add an index of all recipes
  • Add an ID to each recipe that can be linked to
  • Add title/short description/driver/tags to each recipe for the index's use (e.g. we can generate index pages for each language and tag and driver). Prior art: sphinx-tags
  • Highlight the cookbook examples more strongly on the home page
    • e.g. link directly to language or driver examples
    • add a carousel showcasing some common tasks

Strawman:

# --- RECIPE ---
# title: "Use ADBC PostgreSQL with SQLAlchemy"
# tags: [postgresql, sqlalchemy]
# description: Build queries with SQLAlchemy, then submit them via ADBC.
# --- RECIPE ---

import ...

the syntax isn't too big a deal, so long as we pick something that's recognizable but still valid Python

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions