Additional Configuration for Sphinx

[acederberg]

Hi, thank you for this awesome tool!

I have a few questions about adding additional configuration for sphinx.
For instance, I would like to use

• sphinx with markdown and not reStructuredText,
• sphinx with pydantic documentation tooling since I am using pydantic.

I see that griffe also has an extension for pydantic called griffe-pydantic but I cannot get that working either.

Right now, I have the following code to build my documentation:

"""Tools for generating site documentation."""

import os

import griffe
import quartodoc
import typer
from quartodoc.__main__ import chdir

from acederbergio import env, util

QUARTO_CONFIG = env.BLOG / "_quarto.yaml"

cli = typer.Typer()


@cli.command("python")
def cli_create_python_docs():
    """Build python docs using ``quartodoc``."""

    builder: quartodoc.Builder = quartodoc.Builder.from_quarto_config(
        str(QUARTO_CONFIG)
    )

    griffe.load(
        "acederbergio",
        extensions=griffe.load_extensions({"griffe_pydantic": {"schema": True}}),
    )
    with chdir(env.BLOG):
        builder.build()


@cli.command("javascript")
def cli_create_javascript_docs():
    """Build javascript documentation using ``typedoc``."""

    util.CONSOLE.print("[red]Not implemented yet.")
    raise typer.Exit(1)


if __name__ == "__main__":
    cli()

How can I make this work?

[acederberg]

Additionally, a more general question I have is how to make sphinx recognize typing_extensions.Doc (see PEP 727). For instance, I would like to be able to generate documentation for

from typing_extensions import Doc
from typing import Annotated

class Thing:
  whatever: Annotated[str, Doc("`whatever` attribute of the `thing` class.")]

Equivalent to writing an ivar in the class docstring. I picked this up from fastapi, for instance in applications.py.