Skip to content

Add support for specifying cross references for a specific section or location in a topic #190

@danroth27

Description

@danroth27

With the DocFX cross reference support it looks like you can easily define links to different docs in your project, which is great!

We also need to be ability to define cross references to specific places in a doc, like a specific section or a specific label. In Sphinx we use the :ref:label-name`` syntax to define these references:

.. _my-reference-label:

Section to cross-reference
--------------------------

This is the text of the section.

It refers to the section itself, see :ref:`my-reference-label`.

We need something similar in DocFX. It would be great if there was even a shorthand for referencing a specific section heading without having to define an explicit label, which is something Sphinx does not have.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions