Skip to content

Error in Guide: Cross-referencing with Sphinx #8172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jofmi opened this issue May 11, 2021 · 1 comment · Fixed by #8173
Closed

Error in Guide: Cross-referencing with Sphinx #8172

jofmi opened this issue May 11, 2021 · 1 comment · Fixed by #8173
Labels
Bug A bug

Comments

@jofmi
Copy link

jofmi commented May 11, 2021

Details

Read the Docs project URL: https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html

The following paragraph:

The reference displays the name of the target by default, but we can use any text you want. 
For example: `my custom text   <target to paragraph>`_, that will be rendered as: my custom text.

Expected Result

The link my custom text should lead to the target.

Actual Result

The link returns a Page not Found error.

@stsewd stsewd added the Bug A bug label May 11, 2021
@stsewd
Copy link
Member

stsewd commented May 11, 2021

oops, looks like this doesn't work as I was expecting, not sure why I didn't realize this when writing the guide. But looks like the ref role does support that :ref:`Target to paragraph <target to paragraph>`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants