The current RecommonMark specification on images [0] says that:
should render as
<p><img src="/url" alt="foo" title="title" /></p>
which means that "foo" should be the `alt` attribute, and "title" should
be the `title` attribute.
Currently, `recommonmark` will:
1. set the `alt` attribute to "title"
2. render "foo" as literal text following the image element.
Neither yields results in line with the RecommonMark standard, resulting
in the following when transformed to HTML:
<p><img src="/url" alt="title" />foo</p>
While it might be surprising that `alt` is set to "title", the more
pressing issue is how the alt text becomes literal text within the
paragraph, typically not rendering well.
This commit instead makes `recommonmark`:
1. set the `alt` attribute to "foo"
2. drop "title" altogether since the `title` attribute is not supported
in Docutils [1].
1 coincides with the specification, and 2 is in my mind the least
surprising solution within the capabilities of Docutils. The HTML will
now be:
<p><img src="/url" alt="foo" /></p>
only differing in the missing `title` attribute when compared to the
specification.
[0]: https://spec.commonmark.org/0.28/#images
[1]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#image
Without this any html_block nodes processed by the parser are dropped.
`visit_html_block` uses the existing logic for `visit_html_inline`.
Added a test case to check html_blocks are parsed as expected.
Fixes: https://github.com/rtfd/recommonmark/issues/121
Sphinx 1.6.5 with tip recommonmark hard errors when a markdown document
contains a cross-reference to another local markdown document as it
unconditionally access the `refdomain` of a `pending_xref`. This was
fixed [elsewhere](https://github.com/ignatenkobrain/sphinxcontrib-issuetracker/pull/13/files#diff-61beda6e59ec3020dbf0c2826dbb64c4R161)
by setting it to `None`. This patch uses the same approach which no
longer causes the Sphinx build to fail on cross-linking a markdown
document however the generated link is not correctly rendered producing
broken links in the generated html.
Addressing the broken links, the `mdnode.destination` is stripped of its
file extension if that extension is supported by `CommonMarkParser`
however this will only work for markdown documents, not ReStructuedText
or any other extended file type parsers.
Fixes#89.
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.
* Moves changes from #61 into this PR
* Drops basic testing from #61
* Adds to implementation pending_xref back down to reference
The implementation in #61 breaks a number of cases, like "/example" and
"example.html", etc. Instead of trying to enumerate case we want an xref instead
of a pending_xref, just pin the xref on the pending_xref to back down.
pending_xref replaces itself with it's children if the reference isn't resolved.
This was already dealing with a rewrite due to the spec change on CommonMark, so
I took the opportunity to modernize the code and clean things up as well.
* Updates to support CommonMark==0.7.3
* Reworks pattern for handling CommonMark nodes, mimic docutils visit/depart
pattern
* Drops SectionHandler class, as it was only used in one place. Merge into the
parser class, where it is used
* Drops requirements file for setup.py config, as this is a package requirements
is superfluous
* Adds a number of more detailed test cases
* Adds test runner for 3.5, 3.6
* Updates strictness on prospector, cleans up linting errors and docstring
problems
