Mercurial Mercurial > pyams > pyams_user_guide / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
src/build/html/pyams_content_es.html
changeset 0 d153941bb745 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_content_es.html	Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,414 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>pyams_content_es package &#8212; PyAMS User Guide 0.1.0 documentation</title>
+    <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '0.1.0',
+        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>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
+<!--[if lte IE 6]>
+<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
+<![endif]-->
+
+  </head>
+  <body>
+
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="pyams-content-es-package">
+<h1>pyams_content_es package<a class="headerlink" href="#pyams-content-es-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="pyams_content_es.component.html">pyams_content_es.component package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.extfile">pyams_content_es.component.extfile module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.gallery">pyams_content_es.component.gallery module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.paragraph">pyams_content_es.component.paragraph module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.theme">pyams_content_es.component.theme module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.view">pyams_content_es.component.view module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component.workflow">pyams_content_es.component.workflow module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.component.html#module-pyams_content_es.component">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_content_es.interfaces.html">pyams_content_es.interfaces package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.interfaces.html#module-pyams_content_es.interfaces">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_content_es.scripts.html">pyams_content_es.scripts package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.scripts.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.scripts.html#module-pyams_content_es.scripts.index">pyams_content_es.scripts.index module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.scripts.html#module-pyams_content_es.scripts">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_content_es.tests.html">pyams_content_es.tests package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.tests.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.tests.html#module-pyams_content_es.tests.test_utilsdocs">pyams_content_es.tests.test_utilsdocs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.tests.html#module-pyams_content_es.tests.test_utilsdocstrings">pyams_content_es.tests.test_utilsdocstrings module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.tests.html#module-pyams_content_es.tests">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_content_es.zmi.html">pyams_content_es.zmi package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.zmi.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.zmi.html#module-pyams_content_es.zmi.test">pyams_content_es.zmi.test module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_content_es.zmi.html#module-pyams_content_es.zmi">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="module-pyams_content_es.document">
+<span id="pyams-content-es-document-module"></span><h2>pyams_content_es.document module<a class="headerlink" href="#module-pyams_content_es.document" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_content_es.document.ElasticMixin">
+<em class="property">class </em><code class="descclassname">pyams_content_es.document.</code><code class="descname">ElasticMixin</code><a class="headerlink" href="#pyams_content_es.document.ElasticMixin" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">pyramid_es.mixin.ElasticMixin</span></code></p>
+<p>ElasticSearch base mixin class</p>
+<dl class="method">
+<dt id="pyams_content_es.document.ElasticMixin.elastic_document">
+<code class="descname">elastic_document</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.document.ElasticMixin.elastic_document" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_content_es.document.ElasticMixin.elastic_mapping">
+<code class="descname">elastic_mapping</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.document.ElasticMixin.elastic_mapping" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content_es.document.ElasticMixin.id">
+<code class="descname">id</code><a class="headerlink" href="#pyams_content_es.document.ElasticMixin.id" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content_es.document.ElasticMixin.internal_id">
+<code class="descname">internal_id</code><a class="headerlink" href="#pyams_content_es.document.ElasticMixin.internal_id" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content_es.document.WfSharedContentIndexInfo">
+<code class="descclassname">pyams_content_es.document.</code><code class="descname">WfSharedContentIndexInfo</code><span class="sig-paren">(</span><em>content</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.document.WfSharedContentIndexInfo" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-pyams_content_es.include">
+<span id="pyams-content-es-include-module"></span><h2>pyams_content_es.include module<a class="headerlink" href="#module-pyams_content_es.include" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_content_es.include.handle_new_application">
+<code class="descclassname">pyams_content_es.include.</code><code class="descname">handle_new_application</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.include.handle_new_application" title="Permalink to this definition">¶</a></dt>
+<dd><p>Start indexer process when application created</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content_es.include.include_package">
+<code class="descclassname">pyams_content_es.include.</code><code class="descname">include_package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.include.include_package" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_content_es.index">
+<span id="pyams-content-es-index-module"></span><h2>pyams_content_es.index module<a class="headerlink" href="#module-pyams_content_es.index" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_content_es.index.handle_added_document">
+<code class="descclassname">pyams_content_es.index.</code><code class="descname">handle_added_document</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.handle_added_document" title="Permalink to this definition">¶</a></dt>
+<dd><p>Handle added document</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content_es.index.handle_modified_document">
+<code class="descclassname">pyams_content_es.index.</code><code class="descname">handle_modified_document</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.handle_modified_document" title="Permalink to this definition">¶</a></dt>
+<dd><p>Handle modified document</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content_es.index.handle_removed_document">
+<code class="descclassname">pyams_content_es.index.</code><code class="descname">handle_removed_document</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.handle_removed_document" title="Permalink to this definition">¶</a></dt>
+<dd><p>Handle removed document</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content_es.index.index_document">
+<code class="descclassname">pyams_content_es.index.</code><code class="descname">index_document</code><span class="sig-paren">(</span><em>status</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.index_document" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="function">
+<dt id="pyams_content_es.index.unindex_document">
+<code class="descclassname">pyams_content_es.index.</code><code class="descname">unindex_document</code><span class="sig-paren">(</span><em>status</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.index.unindex_document" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-pyams_content_es.process">
+<span id="pyams-content-es-process-module"></span><h2>pyams_content_es.process module<a class="headerlink" href="#module-pyams_content_es.process" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_content_es.process.BaseIndexerProcess">
+<em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">BaseIndexerProcess</code><span class="sig-paren">(</span><em>settings</em>, <em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.BaseIndexerProcess" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">multiprocessing.context.Process</span></code></p>
+<p>Base indexer process</p>
+<dl class="method">
+<dt id="pyams_content_es.process.BaseIndexerProcess.run">
+<code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.BaseIndexerProcess.run" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_content_es.process.BaseIndexerProcess.update_index">
+<code class="descname">update_index</code><span class="sig-paren">(</span><em>client</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.BaseIndexerProcess.update_index" title="Permalink to this definition">¶</a></dt>
+<dd><p>Update index</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content_es.process.ContentIndexerHandler">
+<em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">ContentIndexerHandler</code><a class="headerlink" href="#pyams_content_es.process.ContentIndexerHandler" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Content indexer handler</p>
+<dl class="method">
+<dt id="pyams_content_es.process.ContentIndexerHandler.index">
+<code class="descname">index</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerHandler.index" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_content_es.process.ContentIndexerHandler.test">
+<code class="descname">test</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerHandler.test" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_content_es.process.ContentIndexerHandler.unindex">
+<code class="descname">unindex</code><span class="sig-paren">(</span><em>settings</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerHandler.unindex" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content_es.process.ContentIndexerMessageHandler">
+<em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">ContentIndexerMessageHandler</code><span class="sig-paren">(</span><em>process</em>, <em>stream</em>, <em>stop</em>, <em>handler=None</em>, <em>json_load=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerMessageHandler" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_zmq.html#pyams_zmq.handler.ZMQMessageHandler" title="pyams_zmq.handler.ZMQMessageHandler"><code class="xref py py-class docutils literal"><span class="pre">pyams_zmq.handler.ZMQMessageHandler</span></code></a></p>
+<p>Content indexer message handler</p>
+<dl class="attribute">
+<dt id="pyams_content_es.process.ContentIndexerMessageHandler.handler">
+<code class="descname">handler</code><a class="headerlink" href="#pyams_content_es.process.ContentIndexerMessageHandler.handler" title="Permalink to this definition">¶</a></dt>
+<dd><p>alias of <a class="reference internal" href="#pyams_content_es.process.ContentIndexerHandler" title="pyams_content_es.process.ContentIndexerHandler"><code class="xref py py-class docutils literal"><span class="pre">ContentIndexerHandler</span></code></a></p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content_es.process.ContentIndexerProcess">
+<em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">ContentIndexerProcess</code><span class="sig-paren">(</span><em>zmq_address</em>, <em>handler</em>, <em>registry</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.ContentIndexerProcess" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_zmq.html#pyams_zmq.process.ZMQProcess" title="pyams_zmq.process.ZMQProcess"><code class="xref py py-class docutils literal"><span class="pre">pyams_zmq.process.ZMQProcess</span></code></a></p>
+<p>Content indexer ZMQ process</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content_es.process.IndexerProcess">
+<em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">IndexerProcess</code><span class="sig-paren">(</span><em>settings</em>, <em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.IndexerProcess" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#pyams_content_es.process.BaseIndexerProcess" title="pyams_content_es.process.BaseIndexerProcess"><code class="xref py py-class docutils literal"><span class="pre">pyams_content_es.process.BaseIndexerProcess</span></code></a></p>
+<p>Content indexer process</p>
+<dl class="method">
+<dt id="pyams_content_es.process.IndexerProcess.update_index">
+<code class="descname">update_index</code><span class="sig-paren">(</span><em>client</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.IndexerProcess.update_index" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content_es.process.IndexerThread">
+<em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">IndexerThread</code><span class="sig-paren">(</span><em>process</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.IndexerThread" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">threading.Thread</span></code></p>
+<p>Content indexer thread</p>
+<dl class="method">
+<dt id="pyams_content_es.process.IndexerThread.run">
+<code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.IndexerThread.run" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_content_es.process.UnindexerProcess">
+<em class="property">class </em><code class="descclassname">pyams_content_es.process.</code><code class="descname">UnindexerProcess</code><span class="sig-paren">(</span><em>settings</em>, <em>group=None</em>, <em>target=None</em>, <em>name=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.UnindexerProcess" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#pyams_content_es.process.BaseIndexerProcess" title="pyams_content_es.process.BaseIndexerProcess"><code class="xref py py-class docutils literal"><span class="pre">pyams_content_es.process.BaseIndexerProcess</span></code></a></p>
+<p>Content un-indexer process</p>
+<dl class="method">
+<dt id="pyams_content_es.process.UnindexerProcess.update_index">
+<code class="descname">update_index</code><span class="sig-paren">(</span><em>client</em>, <em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.process.UnindexerProcess.update_index" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_content_es.site">
+<span id="pyams-content-es-site-module"></span><h2>pyams_content_es.site module<a class="headerlink" href="#module-pyams_content_es.site" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_content_es.site.ContentIndexerGenerationsChecker">
+<em class="property">class </em><code class="descclassname">pyams_content_es.site.</code><code class="descname">ContentIndexerGenerationsChecker</code><a class="headerlink" href="#pyams_content_es.site.ContentIndexerGenerationsChecker" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Content indexer utility generations checker</p>
+<dl class="method">
+<dt id="pyams_content_es.site.ContentIndexerGenerationsChecker.evolve">
+<code class="descname">evolve</code><span class="sig-paren">(</span><em>site</em>, <em>current=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.site.ContentIndexerGenerationsChecker.evolve" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check for required utilities</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content_es.site.ContentIndexerGenerationsChecker.generation">
+<code class="descname">generation</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_content_es.site.ContentIndexerGenerationsChecker.generation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content_es.site.handle_new_local_site">
+<code class="descclassname">pyams_content_es.site.</code><code class="descname">handle_new_local_site</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.site.handle_new_local_site" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a new indexer utility when a site is created</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_content_es.site.site_index">
+<code class="descclassname">pyams_content_es.site.</code><code class="descname">site_index</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.site.site_index" title="Permalink to this definition">¶</a></dt>
+<dd><p>Index all site contents in ElasticSearch</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_content_es.utility">
+<span id="pyams-content-es-utility-module"></span><h2>pyams_content_es.utility module<a class="headerlink" href="#module-pyams_content_es.utility" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_content_es.utility.ContentIndexerUtility">
+<em class="property">class </em><code class="descclassname">pyams_content_es.utility.</code><code class="descname">ContentIndexerUtility</code><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
+<p>Content indexer utility</p>
+<dl class="method">
+<dt id="pyams_content_es.utility.ContentIndexerUtility.index_document">
+<code class="descname">index_document</code><span class="sig-paren">(</span><em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility.index_document" title="Permalink to this definition">¶</a></dt>
+<dd><p>Send index request for given document</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_content_es.utility.ContentIndexerUtility.test_process">
+<code class="descname">test_process</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility.test_process" title="Permalink to this definition">¶</a></dt>
+<dd><p>Send test request to indexer process</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_content_es.utility.ContentIndexerUtility.unindex_document">
+<code class="descname">unindex_document</code><span class="sig-paren">(</span><em>document</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility.unindex_document" title="Permalink to this definition">¶</a></dt>
+<dd><p>Send unindex request for given document</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_content_es.utility.ContentIndexerUtility.zodb_name">
+<code class="descname">zodb_name</code><a class="headerlink" href="#pyams_content_es.utility.ContentIndexerUtility.zodb_name" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_content_es">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_content_es" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_content_es.includeme">
+<code class="descclassname">pyams_content_es.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_content_es.includeme" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+</dd></dl>
+
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">pyams_content_es package</a><ul>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-pyams_content_es.document">pyams_content_es.document module</a></li>
+<li><a class="reference internal" href="#module-pyams_content_es.include">pyams_content_es.include module</a></li>
+<li><a class="reference internal" href="#module-pyams_content_es.index">pyams_content_es.index module</a></li>
+<li><a class="reference internal" href="#module-pyams_content_es.process">pyams_content_es.process module</a></li>
+<li><a class="reference internal" href="#module-pyams_content_es.site">pyams_content_es.site module</a></li>
+<li><a class="reference internal" href="#module-pyams_content_es.utility">pyams_content_es.utility module</a></li>
+<li><a class="reference internal" href="#module-pyams_content_es">Module contents</a></li>
+</ul>
+</li>
+</ul>
+
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2017, Thierry Florac.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
+    </div>
+  </body>
+</html>
\ No newline at end of file
pyams/pyams_user_guide