:ref: role does not generate a link #122

Closed
zhouyaoji opened this Issue Jun 16, 2012 · 3 comments

Comments

Projects
None yet
3 participants
@zhouyaoji

The :ref: role in conjunction with reST labels allows you to link to arbitrary locations in the document. The rest2html script used by GitHub just ignores the :ref: role.

In the example below, the sentence starting with :ref: should be rendered into a link to the label (_ref_link).

:ref:How do you create arbitrary links in reST? <ref_link>

.. _ref_link:
.. topic:: Making Arbitrary LInks in reST

To make arbitrary links in reST, you use the ``:ref:`` role with a label that is prefixed with an underscore....

I wrote documentation in reST for Mojito, a Node.js-based Web framework, but the FAQ does not render nicely because I use the :ref: role to link the questions to the answers.

See the following as a reference: https://github.com/yahoo/mojito/blob/develop/docs/dev_guide/faq/index.rst

@zhouyaoji

This comment has been minimized.

Show comment Hide comment
@zhouyaoji

zhouyaoji Jun 16, 2012

The following from the Sphinx docs also explains how :ref: is supposed to work:
http://sphinx.pocoo.org/markup/inline.html#cross-referencing-arbitrary-locations

The following from the Sphinx docs also explains how :ref: is supposed to work:
http://sphinx.pocoo.org/markup/inline.html#cross-referencing-arbitrary-locations

@bkeepers bkeepers added rst labels May 29, 2014

@mightyiam

This comment has been minimized.

Show comment Hide comment
@mightyiam

mightyiam Sep 14, 2014

:ref: is Sphinx specific. Are Sphinx things supposed to work in GitHub Markup?

:ref: is Sphinx specific. Are Sphinx things supposed to work in GitHub Markup?

@kynan kynan referenced this issue in OP2/PyOP2 Sep 25, 2014

Merged

Modify the installation instructions #405

@bkeepers

This comment has been minimized.

Show comment Hide comment
@bkeepers

bkeepers Sep 26, 2014

Owner

We don't currently support any extensions. You can see the current implementation here: https://github.com/github/markup/blob/master/lib/github/commands/rest2html

Owner

bkeepers commented Sep 26, 2014

We don't currently support any extensions. You can see the current implementation here: https://github.com/github/markup/blob/master/lib/github/commands/rest2html

@bkeepers bkeepers closed this Sep 26, 2014

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