Skip to content

Commit 1834a85

Browse files
authored
docs: update references to specific pages (#1131)
I noticed that the link was taking the reader to the main index page. Change the links to be more specific to target the actual pages in question. Signed-off-by: Mike Fiedler <[email protected]> Signed-off-by: Mike Fiedler <[email protected]>
1 parent 73e12ea commit 1834a85

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

source/guides/making-a-pypi-friendly-readme.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ If your README is written in reStructuredText, any invalid markup will prevent
9797
it from rendering, causing PyPI to instead just show the README's raw source.
9898

9999
Note that Sphinx extensions used in docstrings, such as
100-
:doc:`directives and roles <sphinx:usage/restructuredtext/index>`
100+
:doc:`directives <sphinx:usage/restructuredtext/directives>` and :doc:`roles <sphinx:usage/restructuredtext/roles>`
101101
(e.g., "``:py:func:`getattr```" or "``:ref:`my-reference-label```"), are not allowed here and will result in error
102102
messages like "``Error: Unknown interpreted text role "py:func".``".
103103

0 commit comments

Comments
 (0)