Skip to content

feature: Support enabling signature_crossrefs without enabling separate_signature #270

Open
@ofek

Description

@ofek

Is your feature request related to a problem? Please describe.

I need to offer the ability to click on a type and go to the documentation for that type. Also, I would like the default compact signatures with syntax highlighting.

Describe the solution you'd like

Support for enabling signature_crossrefs without enabling separate_signature.

Describe alternatives you've considered

  1. Enabling separate_signature everywhere
  2. Enabling separate_signature only for signatures that actually have types defined by local code rather than the built-in types like list, which leads to inconsistent formatting like in this screenshot Image

Additional context

I understand based on your assessment in #65 (comment) that this approach is not without trade-offs but I think would be beneficial to users nonetheless even if you imposed certain limitations.

Activity

pawamoy

pawamoy commented on Apr 9, 2025

@pawamoy
Member

Hey @ofek, thanks for the feature request!

I don't think the comment you mention is relevant to this, as it was more generally about cross-refs in code blocks, while here we want cross-refs in inline code. I don't see anything preventing us from adding support for cross-refs in inline signatures (though I might be forgetting something), however note that there won't be any syntax highlighting or formatting 🙂 Other docs generators output their own set of spans and CSS classes to bring colors, which we won't do as part of this feature (but this can be requested later).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

cross-refsRelated to cross-referencesfeatureNew feature or requestinsidersCandidate for Insiders

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @pawamoy@ofek

      Issue actions

        feature: Support enabling `signature_crossrefs` without enabling `separate_signature` · Issue #270 · mkdocstrings/python