d067e096ef
Add cross-reference labeling.
...
hide label text
2019-08-22 17:28:00 +02:00
Eric Holscher
c4d575bd7b
Merge pull request #160 from tbeadle/auto_toc_maxdepth
...
Allow the Auto TOC maxdepth to be configurable.
2019-08-09 11:19:49 -07:00
Gibson Fahnestock
0e96d97ef0
Add known_url_schemes option to allow toplevel refs
...
Fixes: https://github.com/readthedocs/recommonmark/issues/165
2019-07-29 11:40:21 +01:00
Tommy Beadle
4bd0eab865
Allow the Auto TOC maxdepth to be configurable.
...
This adds the 'auto_toc_maxdepth' config option (defaults to 1) that
will set the max depth for the auto-generated table of contents.
2019-06-21 15:12:08 -04:00
Gibson Fahnestock
ec0ada952d
Remove URL quoting from refs before passing to Sphinx
...
Sphinx allows refs with spaces etc, and in fact autogenerates them with
the command [`autosectionlabel`][].
So if you put a:
```markdown
[Link 1](<some ref>)
[Link 2](<https://foo.com/bar baz>)
```
Then the links will be `some%20ref` and `https://foo.com/bar%20baz `.
We want to keep the URL quoting for external references, but if we're
passing it as `:any:` to Sphinx we need to unquote so Sphinx can find
the correct reference, the `<some ref>` should map to:
```rst
:ref:`some ref`
```
[`autosectionlabel`](https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html )
Fixes: https://github.com/rtfd/recommonmark/issues/155
2019-05-23 16:01:37 +02:00
Takeshi KOMIYA
029c649065
Register a parser class using new Sphinx API; add_source_suffix
2018-07-28 18:14:42 +09:00
Chris Holdgraf
25db3cb68d
Updating autostructify links in readme
...
The links are hard to find, so this makes them more discoverable
2018-02-10 08:41:14 -08:00
Anthony Johnson
8baf238562
Fix linking, add tests, fix auto toc, deprecate and remove auto ref
...
This fixes link nesting, and resolves some issues around links not closing
correctly. There were a few changes required to support the autotoc feature, and
the auto ref feature has be deprecated. This feature no longer is required, as
we are doing pending_xref natively. The functionality was breaking Sphinx
altogether, so it doesn't make sense to keep it and deprecate the feature.
2017-03-03 01:20:23 -08:00
Paul
c64958e5e8
Add info how links are handled in the doc
2017-02-23 16:45:27 -06:00
Chris Ewald
908c6669ef
bold the option keys in the readme
2016-03-10 15:41:39 -05:00
Chris Ewald
1a52eba1c7
add autostructify section to main readme
2016-03-10 15:36:12 -05:00
Dmitry Shachnev
0d7fa5abcb
README.md: Link to the new CommonMark-py repository
2016-02-07 19:11:06 +03:00
Jannis Leidel
a9042d9ad5
Unindent code examples in README.
...
This prevents copying leading spaces.
2015-10-29 23:19:12 +01:00
Eric Holscher
935f66e303
Fix syntax in readme
2015-10-20 16:13:16 -07:00
Eric Holscher
4a0915e28b
Symlink readme to doc index
2015-10-19 14:13:45 -07:00
Eric Holscher
9c1583b106
A bit more wording
2015-10-19 10:58:26 -07:00
Eric Holscher
a3f0dc8173
Make readme a bit more friendly
2015-10-19 10:57:39 -07:00
Anthony Johnson
ed65113f82
Add missing documentation link
2015-08-23 15:19:28 -07:00
Eric Holscher
044b0120ae
Small readme cleanup
2015-07-28 11:15:59 -07:00
Eric Holscher
4853978e48
More readme cleanup
2015-07-28 11:12:27 -07:00
Eric Holscher
28bf44f1be
Add README ack for Luca
2015-07-28 10:44:19 -07:00
Luca Barbato
fec4719f9f
Rename the project as recommonmark
2014-12-08 00:25:40 +01:00
sgenoud
212c8e15ac
It looks better on github now
2013-08-25 17:06:26 +02:00
Steve Genoud
21d5fab2ba
Initial commit
2013-08-25 16:45:13 +02:00
