canonical_tutorial.py

"""Extension for a stub ``canonical-tutorial`` directive."""

from __future__ import annotations

from typing import TYPE_CHECKING

from sphinx.util.docutils import SphinxDirective
from sphinx.util.typing import ExtensionMetadata

if TYPE_CHECKING:
    from typing import ClassVar

    from docutils import nodes
    from sphinx.application import Sphinx


class CanonicalTutorial(SphinxDirective):
    """In the scanpy-tutorials repo, this links to the canonical location (here!)."""

    required_arguments: ClassVar = 1

    def run(self) -> list[nodes.Node]:  # noqa: D102
        return []


def setup(app: Sphinx) -> ExtensionMetadata:
    """App setup hook."""
    app.add_directive("canonical-tutorial", CanonicalTutorial)
    return ExtensionMetadata(parallel_read_safe=True)