Skip to content

Set the default_role to any #74

Open
@rdb

Description

@rdb

It can be quite tedious (and hurt readability) to keep typing out the roles for external references:

The method :meth:`~.NodePath.set_shader_input()` stores data that can be accessed
by the shader. It is possible to store data of type :class:`.Texture`,
:class:`.NodePath`, and any vector object.

Sphinx allows you to set the default_role, which will be used whenever single backticks are used without a prefix. I suggest setting it to :any:, which will make Sphinx automatically figure out what you are talking about and link it as appropriate. I think we can get the above down to:

The method `~NodePath.set_shader_input()` stores data that can be accessed by
the shader. It is possible to store data of type `Texture`, `NodePath`, and any
vector object.

:any: will also find glossary terms, or really any kind of reference (as the name suggests), which might be useful in text that is continuously referring to things like `render` or other Panda-specific terms.

Thoughts?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions