Hopiu/django-markdownx
1
0
Fork 0
mirror of https://github.com/Hopiu/django-markdownx.git synced 2026-05-19 10:01:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
django-markdownx/docs/markdownx/docs/exceptions.html

333 lines
12 KiB
HTML
Raw Normal View History

documentations.
2017-04-23 12:52:52 +00:00
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Issue #64 + slight improvement.
2017-05-04 10:24:06 +00:00
<title>Exceptions &mdash; Django Markdownx 2.0.19 documentation</title>
documentations.
2017-04-23 12:52:52 +00:00
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
Issue #64 + slight improvement.
2017-05-04 10:24:06 +00:00
<link rel="top" title="Django Markdownx 2.0.19 documentation" href="../../index.html"/>
documentations.
2017-04-23 12:52:52 +00:00
<link rel="up" title="MarkdownX Modules" href="../markdownx.html"/>
<link rel="next" title="Fields" href="fields.html"/>
<link rel="prev" title="Admin" href="admins.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> Django Markdownx
</a>
<div class="version">
2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../example.html">Example</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../customization.html">Customization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../translation.html">Translation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../js/js.html">JavaScript</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../markdownx.html">MarkdownX Modules</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="admins.html">Admin</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="fields.html">Fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="forms.html">Form</a></li>
<li class="toctree-l2"><a class="reference internal" href="models.html">Models</a></li>
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<li class="toctree-l2"><a class="reference internal" href="urls.html">URLs</a></li>
documentations.
2017-04-23 12:52:52 +00:00
<li class="toctree-l2"><a class="reference internal" href="utilities.html">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li>
</ul>
</li>
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<li class="toctree-l1"><a class="reference internal" href="../../contribution.html">Contributions</a></li>
documentations.
2017-04-23 12:52:52 +00:00
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Django Markdownx</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> &raquo;</li>
<li><a href="../markdownx.html">MarkdownX Modules</a> &raquo;</li>
<li>Exceptions</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/adi-/django-markdownx/tree/master/markdownx/exceptions.py" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-markdownx.exceptions">
<span id="exceptions"></span><h1>Exceptions<a class="headerlink" href="#module-markdownx.exceptions" title="Permalink to this headline"></a></h1>
<dl class="exception">
<dt id="markdownx.exceptions.MarkdownxImageUploadError">
<em class="property">exception </em><code class="descclassname">markdownx.exceptions.</code><code class="descname">MarkdownxImageUploadError</code><span class="sig-paren">(</span><em>message</em>, <em>code=None</em>, <em>params=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/markdownx/exceptions.html#MarkdownxImageUploadError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#markdownx.exceptions.MarkdownxImageUploadError" title="Permalink to this definition"></a></dt>
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<dd><p>Custom <strong>MarkdownX</strong> exceptions.</p>
<dl class="staticmethod">
documentations.
2017-04-23 12:52:52 +00:00
<dt id="markdownx.exceptions.MarkdownxImageUploadError.invalid_size">
<em class="property">static </em><code class="descname">invalid_size</code><span class="sig-paren">(</span><em>current</em>, <em>expected</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/markdownx/exceptions.html#MarkdownxImageUploadError.invalid_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#markdownx.exceptions.MarkdownxImageUploadError.invalid_size" title="Permalink to this definition"></a></dt>
<dd><p>The file is larger in size that the maximum allow in <span class="guilabel">settings.py</span> (or the default).</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">Parameters:</th><td class="field-body"><ul class="first simple">
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<li><strong>current</strong> (<em>float</em><em>, </em><em>int</em>) &#8211; Current size of the file.</li>
<li><strong>expected</strong> (<em>float</em><em>, </em><em>int</em>) &#8211; Expected (maximum permitted) size of the file.</li>
documentations.
2017-04-23 12:52:52 +00:00
</ul>
</td>
</tr>
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><p>Locale compatible version of the error with the following message:</p>
<ul class="simple">
<li>Please keep file size under %(max)s. Current file size: %(current)s.&#8217;</li>
</ul>
</p>
documentations.
2017-04-23 12:52:52 +00:00
</td>
</tr>
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#markdownx.exceptions.MarkdownxImageUploadError" title="markdownx.exceptions.MarkdownxImageUploadError">MarkdownxImageUploadError</a></p>
documentations.
2017-04-23 12:52:52 +00:00
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="staticmethod">
<dt id="markdownx.exceptions.MarkdownxImageUploadError.not_uploaded">
<em class="property">static </em><code class="descname">not_uploaded</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/markdownx/exceptions.html#MarkdownxImageUploadError.not_uploaded"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#markdownx.exceptions.MarkdownxImageUploadError.not_uploaded" title="Permalink to this definition"></a></dt>
<dd><p>No file is available to upload.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Locale compatible version of the error with the following message:<ul class="simple">
<li>No files have been uploaded.</li>
</ul>
</td>
documentations.
2017-04-23 12:52:52 +00:00
</tr>
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#markdownx.exceptions.MarkdownxImageUploadError" title="markdownx.exceptions.MarkdownxImageUploadError">MarkdownxImageUploadError</a></td>
documentations.
2017-04-23 12:52:52 +00:00
</tr>
</tbody>
</table>
</dd></dl>
<dl class="staticmethod">
<dt id="markdownx.exceptions.MarkdownxImageUploadError.unsupported_format">
<em class="property">static </em><code class="descname">unsupported_format</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/markdownx/exceptions.html#MarkdownxImageUploadError.unsupported_format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#markdownx.exceptions.MarkdownxImageUploadError.unsupported_format" title="Permalink to this definition"></a></dt>
<dd><p>The file is of a format not defined in <span class="guilabel">settings.py</span>
or if default, in <span class="guilabel">markdownx/settings.py</span>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Locale compatible version of the error with the following message:<ul class="simple">
<li>File type is not supported.</li>
</ul>
</td>
documentations.
2017-04-23 12:52:52 +00:00
</tr>
Updated the docs + minor clean ups.
2017-04-25 00:17:10 +00:00
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#markdownx.exceptions.MarkdownxImageUploadError" title="markdownx.exceptions.MarkdownxImageUploadError">MarkdownxImageUploadError</a></td>
documentations.
2017-04-23 12:52:52 +00:00
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="fields.html" class="btn btn-neutral float-right" title="Fields" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="admins.html" class="btn btn-neutral" title="Admin" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2017 - Adi, Pouria Hadjibagheri.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
Issue #64 + slight improvement.
2017-05-04 10:24:06 +00:00
VERSION:'2.0.19',
documentations.
2017-04-23 12:52:52 +00:00
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
Reference in a new issue Copy permalink