Skip to content
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

add info on cross-referencing to the docs #142

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/src/vertex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,11 @@ output:
WARNING: suspect link found. vertex node-004 is linked to vertex node-003 with a fingerprint of '1234', but node-003's fingerprint is 'c6Rq'.
node-004 should be reviewed, and the link fingerprint manually updated.

Cross-Referencing
=================

It is possible to add cross-references to vertices from other places in the document. For example, to create a cross reference to :ref:`node-001` you can use this syntax: ``:ref:`node-001``

Configuration
=============

Expand Down