hiro/recommonmark
1
0
Fork 0
mirror of https://github.com/vale981/recommonmark synced 2025-03-05 10:01:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add info how links are handled in the doc

Browse source
This commit is contained in:
Paul 2017-02-23 16:45:27 -06:00
parent a551eed06c
commit c64958e5e8
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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.