diff -r 7622b6330e62 -r 6df711503ec0 eric6/Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html
--- a/eric6/Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html Sun Oct 20 11:19:38 2019 +0200
+++ b/eric6/Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html Tue Oct 22 19:56:56 2019 +0200
@@ -43,7 +43,15 @@
<td>Class implementing a previewer widget for HTML, Markdown and ReST files.</td>
</tr>
<tr>
-<td><a href="#_StrikeThroughExtension">_StrikeThroughExtension</a></td>
+<td><a href="#_CaretExtension">_CaretExtension</a></td>
+<td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
+</tr>
+<tr>
+<td><a href="#_MarkExtension">_MarkExtension</a></td>
+<td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
+</tr>
+<tr>
+<td><a href="#_TildeExtension">_TildeExtension</a></td>
<td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
</tr>
</table>
@@ -150,31 +158,42 @@
</dl>
<a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a>
<h4>PreviewProcessingThread.__convertMarkdown</h4>
-<b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, htmlFormat</i>)
+<b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, usePyMdownExtensions, htmlFormat</i>)
<p>
Private method to convert Markdown text into HTML.
</p>
<dl>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
<dd>
-text to be processed (string)
+text to be processed
</dd>
-<dt><i>convertNewLineToBreak</i></dt>
+<dt><i>convertNewLineToBreak</i> (bool)</dt>
<dd>
flag indicating to convert new lines
- to HTML break (Markdown only) (boolean)
+ to HTML break (Markdown only)
</dd>
-<dt><i>htmlFormat</i></dt>
+<dt><i>usePyMdownExtensions</i> (bool)</dt>
<dd>
-HTML format to be generated by markdown (string)
+flag indicating to enable the PyMdown
+ extensions, if they are available
+</dd>
+<dt><i>htmlFormat</i> (str)</dt>
+<dd>
+HTML format to be generated by markdown
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
-processed HTML (string)
+processed HTML
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a>
@@ -253,7 +272,7 @@
</dl>
<a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a>
<h4>PreviewProcessingThread.__getHtml</h4>
-<b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
+<b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
<p>
Private method to process the given text depending upon the given
@@ -261,52 +280,60 @@
</p>
<dl>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
<dd>
-language of the text (string)
+language of the text
</dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
<dd>
-to be processed (string)
+to be processed
</dd>
-<dt><i>ssiEnabled</i></dt>
+<dt><i>ssiEnabled</i> (bool)</dt>
<dd>
flag indicating to do some (limited) SSI processing
- (boolean)
</dd>
-<dt><i>filePath</i></dt>
+<dt><i>filePath</i> (str)</dt>
<dd>
-file path of the text (string)
+file path of the text
</dd>
-<dt><i>rootPath</i></dt>
+<dt><i>rootPath</i> (str)</dt>
<dd>
-root path to be used for SSI processing (str)
+root path to be used for SSI processing
</dd>
-<dt><i>useSphinx</i></dt>
+<dt><i>useSphinx</i> (bool)</dt>
<dd>
flag indicating to use Sphinx to generate the
- ReST preview (boolean)
+ ReST preview
</dd>
-<dt><i>convertNewLineToBreak</i></dt>
+<dt><i>convertNewLineToBreak</i> (bool)</dt>
<dd>
flag indicating to convert new lines
- to HTML break (Markdown only) (boolean)
+ to HTML break (Markdown only)
</dd>
-<dt><i>markdownHtmlFormat</i></dt>
+<dt><i>usePyMdownExtensions</i> (bool)</dt>
+<dd>
+flag indicating to enable the PyMdown
+ extensions, if they are available
+</dd>
+<dt><i>markdownHtmlFormat</i> (str)</dt>
<dd>
HTML format to be generated by markdown
- (string)
</dd>
-<dt><i>restDocutilsHtmlFormat</i></dt>
+<dt><i>restDocutilsHtmlFormat</i> (str)</dt>
<dd>
HTML format to be generated by docutils
- (string)
</dd>
</dl>
<dl>
<dt>Returns:</dt>
<dd>
-processed HTML text (string)
+processed HTML text
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="PreviewProcessingThread.__processRootPath" ID="PreviewProcessingThread.__processRootPath"></a>
@@ -373,53 +400,55 @@
</dl>
<a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a>
<h4>PreviewProcessingThread.process</h4>
-<b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
+<b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
<p>
Public method to convert the given text to HTML.
</p>
<dl>
-<dt><i>filePath</i></dt>
+<dt><i>filePath</i> (str)</dt>
<dd>
-file path of the text (string)
+file path of the text
</dd>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
<dd>
-language of the text (string)
+language of the text
</dd>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
<dd>
-text to be processed (string)
+text to be processed
</dd>
-<dt><i>ssiEnabled</i></dt>
+<dt><i>ssiEnabled</i> (bool)</dt>
<dd>
flag indicating to do some (limited) SSI processing
- (boolean)
</dd>
-<dt><i>rootPath</i></dt>
+<dt><i>rootPath</i> (str)</dt>
<dd>
-root path to be used for SSI processing (str)
+root path to be used for SSI processing
</dd>
-<dt><i>useSphinx</i></dt>
+<dt><i>useSphinx</i> (bool)</dt>
<dd>
flag indicating to use Sphinx to generate the
- ReST preview (boolean)
+ ReST preview
</dd>
-<dt><i>convertNewLineToBreak</i></dt>
+<dt><i>convertNewLineToBreak</i> (bool)</dt>
<dd>
flag indicating to convert new lines
- to HTML break (Markdown only) (boolean)
+ to HTML break (Markdown only)
</dd>
-<dt><i>markdownHtmlFormat</i></dt>
+<dt><i>usePyMdownExtensions</i> (bool)</dt>
+<dd>
+flag indicating to enable the PyMdown
+ extensions, if they are available
+</dd>
+<dt><i>markdownHtmlFormat</i> (str)</dt>
<dd>
HTML format to be generated by markdown
- (string)
</dd>
-<dt><i>restDocutilsHtmlFormat</i></dt>
+<dt><i>restDocutilsHtmlFormat</i> (str)</dt>
<dd>
HTML format to be generated by docutils
- (string)
</dd>
</dl>
<a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a>
@@ -688,23 +717,23 @@
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
-<a NAME="_StrikeThroughExtension" ID="_StrikeThroughExtension"></a>
-<h2>_StrikeThroughExtension</h2>
+<a NAME="_CaretExtension" ID="_CaretExtension"></a>
+<h2>_CaretExtension</h2>
<p>
- Class is placed here, because it depends on imported markdown,
- and markdown import is lazy.
+ Class is placed here, because it depends on imported
+ markdown, and markdown import is lazy.
</p>
<p>
- (see https://pythonhosted.org/Markdown/extensions/api.html
- this page for details)
+ (see https://pythonhosted.org/Markdown/extensions/api.html
+ this page for details)
</p>
<h3>Derived from</h3>
markdown.Extension
<h3>Class Attributes</h3>
<table>
-<tr><td>DEL_RE</td></tr>
+<tr><td>INS_RE</td></tr><tr><td>SUP_RE</td></tr>
</table>
<h3>Class Methods</h3>
@@ -716,7 +745,7 @@
<table>
<tr>
-<td><a href="#_StrikeThroughExtension.extendMarkdown">extendMarkdown</a></td>
+<td><a href="#_CaretExtension.extendMarkdown">extendMarkdown</a></td>
<td></td>
</tr>
</table>
@@ -726,8 +755,98 @@
<tr><td>None</td></tr>
</table>
-<a NAME="_StrikeThroughExtension.extendMarkdown" ID="_StrikeThroughExtension.extendMarkdown"></a>
-<h4>_StrikeThroughExtension.extendMarkdown</h4>
+<a NAME="_CaretExtension.extendMarkdown" ID="_CaretExtension.extendMarkdown"></a>
+<h4>_CaretExtension.extendMarkdown</h4>
+<b>extendMarkdown</b>(<i>md, md_globals</i>)
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="_MarkExtension" ID="_MarkExtension"></a>
+<h2>_MarkExtension</h2>
+
+<p>
+ Class is placed here, because it depends on imported
+ markdown, and markdown import is lazy.
+</p>
+<p>
+ (see https://pythonhosted.org/Markdown/extensions/api.html
+ this page for details)
+</p>
+<h3>Derived from</h3>
+markdown.Extension
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>MARK_RE</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#_MarkExtension.extendMarkdown">extendMarkdown</a></td>
+<td></td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="_MarkExtension.extendMarkdown" ID="_MarkExtension.extendMarkdown"></a>
+<h4>_MarkExtension.extendMarkdown</h4>
+<b>extendMarkdown</b>(<i>md, md_globals</i>)
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="_TildeExtension" ID="_TildeExtension"></a>
+<h2>_TildeExtension</h2>
+
+<p>
+ Class is placed here, because it depends on imported
+ markdown, and markdown import is lazy.
+</p>
+<p>
+ (see https://pythonhosted.org/Markdown/extensions/api.html
+ this page for details)
+</p>
+<h3>Derived from</h3>
+markdown.Extension
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>DEL_RE</td></tr><tr><td>SUB_RE</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#_TildeExtension.extendMarkdown">extendMarkdown</a></td>
+<td></td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="_TildeExtension.extendMarkdown" ID="_TildeExtension.extendMarkdown"></a>
+<h4>_TildeExtension.extendMarkdown</h4>
<b>extendMarkdown</b>(<i>md, md_globals</i>)
<div align="right"><a href="#top">Up</a></div>
