Skip to content

Commit f0a6474

Browse files
authored
Merge pull request #5077 from stsewd/update-docs-docs
Update docs about contributing to docs
2 parents d91807c + 3d01baa commit f0a6474

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/docs.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,6 @@ Content
3636
but rather break them on semantic meaning (e.g. periods or commas).
3737
Read more about this `here <http://rhodesmill.org/brandon/2012/one-sentence-per-line/>`_.
3838
* If you are cross-referencing to a different page within our website,
39-
use the ``doc`` directive and not a hyperlink.
39+
use the ``doc`` role and not a hyperlink.
40+
* If you are cross-referencing to a section within our website,
41+
use the ``ref`` role with the label from the `autosectionlabel extension <http://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html>`__.

0 commit comments

Comments
 (0)