Skip to content

Python builtin types clash with Guppy builtin types in Sphinx cross-references #47

@maximilianruesch

Description

@maximilianruesch

Python has builtin types for its most primitive data, e.g. str, bool, int and so on. Guppy has some too, and they share the same name, but are not exactly the same. Most of the time, functions that construct Guppy code want to accept the Python variant.

When the Sphinx doc is built, the generated links on the type annotations (e.g. on the @guppy decorator page) do not point to the Python builtin (like they do on https://www.sphinx-doc.org/en/master/usage/domains/python.html#python-signatures for example), but instead point to the Guppy definition:

Image

Since we already define the intersphinx mapping for python:, we shall use python:int and similar to mitigate this in all places.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions