From c64958e5e84f055422a54f2a7faa777828b8907f Mon Sep 17 00:00:00 2001 From: Paul Date: Thu, 23 Feb 2017 16:45:27 -0600 Subject: [PATCH] Add info how links are handled in the doc --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 42df7df..f43eb8b 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,10 @@ source_suffix = ['.rst', '.md'] This allows you to write both `.md` and `.rst` files inside of the same project. +### Links + +For all links in commonmark that aren't explicit URLs, they are treated as cross references with the [`:any:`](http://www.sphinx-doc.org/en/stable/markup/inline.html#role-any) role. This allows referencing a lot of things including files, labels, and even objects in the loaded domain. + ### AutoStructify To use the advanced markdown to rst transformations you must add `AutoStructify` to your Sphinx conf.py.