Updated/completed JavaScript docs.

docs-src/conf.py

@@ -38,7 +38,8 @@ extensions = [
     'sphinx.ext.githubpages',
     'classycode',
     'sphinxcontrib.autoanysrc',
-    'sphinx.ext.autosectionlabel'
+    'sphinx.ext.autosectionlabel',
+    'sphinx.ext.autosummary'
     # 'edit_on_github'
 ]
 

docs-src/js/docs/markdownx.rst

@@ -1,5 +1,22 @@
 MarkdownX
----------
+=========
+
+Frontend (JavaScript) management of Django-MarkdownX package.
+
+Written in JavaScript ECMA 2016, trans-compiled to ECMA 5 (2011).
+
+:Requirements:
+    - Modern browser with support for HTML5 and ECMA 2011+ (IE 10+). Older browsers would work but some features may be
+      missing.
+    - TypeScript 2+
+
+JavaScript ECMA 5 files formatted as ``.js`` or ``.min.js`` are trans-compiled files. Please do not modify such files as
+all changes will be lost. To contribute, please edit ``static-src/markdownx/js/markdownx.ts``. See
+:doc:`contributions<../../contribution>` in the documentations for additional instructions.
+
+.. note:: Typescript type definitions of this module are defined in ``static-src/markdownx/js/types.ts``.
+
+----
 
 .. js:data:: GeneralEventHandlers
 

docs-src/js/docs/utils.rst

@@ -1,6 +1,16 @@
 Utilities
----------
+=========
 
+This module contains various, individually documented tools for front-end software development using JavaScript. The
+original code is implemented in TypeScript 2, and follows the ECMA 2016 standards and protocols.
+
+JavaScript ECMA 5 files formatted as ``.js`` or ``.min.js`` are trans-compiled files. Please do not modify such files as
+all changes will be lost. To contribute, please edit ``static-src/markdownx/js/utils.ts``. See
+:doc:`contributions<../../contribution>` in the documentations for additional instructions.
+
+.. note:: Typescript type definitions of this module are defined in ``static-src/markdownx/js/types.ts``.
+
+----
 
 .. js:function:: getCookie(name)
 
@@ -215,3 +225,22 @@ Utilities
             // or
 
             >>> removeClass(document.getElementById('my-element'), 'classA', 'classB', 'classC');
+
+----
+
+**MIT Software License**
+
+:Copyright 2017: Pouria Hadjibagheri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs-src/markdownx/markdownx.rst

@@ -1,5 +1,6 @@
 MarkdownX Modules
 -----------------
+
 .. toctree::
    :maxdepth: 2
    :glob:

docs/_sources/js/docs/markdownx.rst.txt

@@ -1,5 +1,22 @@
 MarkdownX
----------
+=========
+
+Frontend (JavaScript) management of Django-MarkdownX package.
+
+Written in JavaScript ECMA 2016, trans-compiled to ECMA 5 (2011).
+
+:Requirements:
+    - Modern browser with support for HTML5 and ECMA 2011+ (IE 10+). Older browsers would work but some features may be
+      missing.
+    - TypeScript 2+
+
+JavaScript ECMA 5 files formatted as ``.js`` or ``.min.js`` are trans-compiled files. Please do not modify such files as
+all changes will be lost. To contribute, please edit ``static-src/markdownx/js/markdownx.ts``. See
+:doc:`contributions<../../contribution>` in the documentations for additional instructions.
+
+.. note:: Typescript type definitions of this module are defined in ``static-src/markdownx/js/types.ts``.
+
+----
 
 .. js:data:: GeneralEventHandlers
 

docs/_sources/js/docs/utils.rst.txt

@@ -1,6 +1,16 @@
 Utilities
----------
+=========
 
+This module contains various, individually documented tools for front-end software development using JavaScript. The
+original code is implemented in TypeScript 2, and follows the ECMA 2016 standards and protocols.
+
+JavaScript ECMA 5 files formatted as ``.js`` or ``.min.js`` are trans-compiled files. Please do not modify such files as
+all changes will be lost. To contribute, please edit ``static-src/markdownx/js/utils.ts``. See
+:doc:`contributions<../../contribution>` in the documentations for additional instructions.
+
+.. note:: Typescript type definitions of this module are defined in ``static-src/markdownx/js/types.ts``.
+
+----
 
 .. js:function:: getCookie(name)
 
@@ -215,3 +225,22 @@ Utilities
             // or
 
             >>> removeClass(document.getElementById('my-element'), 'classA', 'classB', 'classC');
+
+----
+
+**MIT Software License**
+
+:Copyright 2017: Pouria Hadjibagheri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/_sources/markdownx/markdownx.rst.txt

@@ -1,5 +1,6 @@
 MarkdownX Modules
 -----------------
+
 .. toctree::
    :maxdepth: 2
    :glob:

docs/js/docs/markdownx.html

@@ -178,6 +178,29 @@
             
   <div class="section" id="markdownx">
 <h1>MarkdownX<a class="headerlink" href="#markdownx" title="Permalink to this headline">¶</a></h1>
+<p>Frontend (JavaScript) management of Django-MarkdownX package.</p>
+<p>Written in JavaScript ECMA 2016, trans-compiled to ECMA 5 (2011).</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Requirements:</th><td class="field-body"><ul class="first last simple">
+<li>Modern browser with support for HTML5 and ECMA 2011+ (IE 10+). Older browsers would work but some features may be
+missing.</li>
+<li>TypeScript 2+</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<p>JavaScript ECMA 5 files formatted as <code class="docutils literal"><span class="pre">.js</span></code> or <code class="docutils literal"><span class="pre">.min.js</span></code> are trans-compiled files. Please do not modify such files as
+all changes will be lost. To contribute, please edit <code class="docutils literal"><span class="pre">static-src/markdownx/js/markdownx.ts</span></code>. See
+<a class="reference internal" href="../../contribution.html"><span class="doc">contributions</span></a> in the documentations for additional instructions.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Typescript type definitions of this module are defined in <code class="docutils literal"><span class="pre">static-src/markdownx/js/types.ts</span></code>.</p>
+</div>
+<hr class="docutils" />
 <dl class="data">
 <dt id="GeneralEventHandlers">
 <code class="descname">GeneralEventHandlers</code><a class="headerlink" href="#GeneralEventHandlers" title="Permalink to this definition">¶</a></dt>

docs/js/docs/utils.html

@@ -178,6 +178,16 @@
             
   <div class="section" id="utilities">
 <h1>Utilities<a class="headerlink" href="#utilities" title="Permalink to this headline">¶</a></h1>
+<p>This module contains various, individually documented tools for front-end software development using JavaScript. The
+original code is implemented in TypeScript 2, and follows the ECMA 2016 standards and protocols.</p>
+<p>JavaScript ECMA 5 files formatted as <code class="docutils literal"><span class="pre">.js</span></code> or <code class="docutils literal"><span class="pre">.min.js</span></code> are trans-compiled files. Please do not modify such files as
+all changes will be lost. To contribute, please edit <code class="docutils literal"><span class="pre">static-src/markdownx/js/utils.ts</span></code>. See
+<a class="reference internal" href="../../contribution.html"><span class="doc">contributions</span></a> in the documentations for additional instructions.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Typescript type definitions of this module are defined in <code class="docutils literal"><span class="pre">static-src/markdownx/js/types.ts</span></code>.</p>
+</div>
+<hr class="docutils" />
 <dl class="function">
 <dt id="getCookie">
 <code class="descname">getCookie</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#getCookie" title="Permalink to this definition">¶</a></dt>
@@ -576,6 +586,26 @@ Default is <code class="docutils literal"><span class="pre">true</span></code>.<
 </table>
 </dd></dl>
 
+<hr class="docutils" />
+<p><strong>MIT Software License</strong></p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Copyright 2017:</th><td class="field-body">Pouria Hadjibagheri</td>
+</tr>
+</tbody>
+</table>
+<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the &#8220;Software&#8221;), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:</p>
+<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.</p>
+<p>THE SOFTWARE IS PROVIDED &#8220;AS IS&#8221;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
 </div>