unimore/pds-2021-g2-nest
unimore/pds-2021-g2-nest
1
Fork 0
mirror of https://github.com/pds-nest/nest.git synced 2024-11-25 06:24:19 +00:00
Code Activity

📔 Begin porting docs to the new format

Browse source
This commit is contained in:
Steffo 2021-05-18 03:16:06 +02:00
parent ce0a8d321e
commit bab5d7235c
Signed by: steffo
GPG key ID: 6965406171929D01
25 changed files with 252 additions and 226 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/build/doctrees/backend/index.doctree vendored
View file

Binary file not shown.

BIN
docs/build/doctrees/environment.pickle vendored
View file

Binary file not shown.

BIN
docs/build/doctrees/index.doctree vendored
View file

Binary file not shown.

BIN
docs/build/doctrees/installation/index.doctree vendored
View file

Binary file not shown.

9
docs/build/html/_sources/index.rst.txt vendored
View file

@ -5,12 +5,19 @@ Benvenuto alla documentazione di N.E.S.T.!
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Manuale :caption: Manuale utente
about/index about/index
installation/index installation/index
.. toctree::
:maxdepth: 2
:caption: Guida sviluppatore
meta/index
.. toctree:: .. toctree::
:caption: Documentazione autogenerata :caption: Documentazione autogenerata

4
docs/build/html/_sources/installation/index.rst.txt vendored
View file

@ -79,7 +79,7 @@ Per creare il database PostgreSQL, si esegua:
Creare un file di configurazione per il backend Creare un file di configurazione per il backend
----------------------------------------------- -----------------------------------------------
Il backend usa un file di configurazione per impostare certe variabili. Il backend usa un file di configurazione per impostare alcune variabili.
Si crei un nuovo file nella working directory del progetto denominato ``config.py``: Si crei un nuovo file nella working directory del progetto denominato ``config.py``:
@ -113,7 +113,7 @@ Le dipendenze Python sono gestite da *Poetry*, e possono essere installate con:
Poetry creerà automaticamente un `venv <https://docs.python.org/3/library/venv.html>`_ e vi installerà all'interno tutti Poetry creerà automaticamente un `venv <https://docs.python.org/3/library/venv.html>`_ e vi installerà all'interno tutti
i pacchetti necessari all'esecuzione del backend e del crawler di N.E.S.T. . i pacchetti necessari all'esecuzione del backend e del crawler di N.E.S.T. .
**Segnatevi il nome** del venv creato da Poetry, in quanto sarà necessario per **Si suggerisce di ricordare il nome del venv creato da Poetry**, in quanto sarà necessario per
:ref:`Creare un servizio SystemD per il backend`: :ref:`Creare un servizio SystemD per il backend`:
.. code-block:: console .. code-block:: console

6
docs/build/html/about/index.html vendored
View file

@ -85,11 +85,15 @@
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Il progetto</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Il progetto</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installazione</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Informazioni sulla documentazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li> <li class="toctree-l1"><a class="reference internal" href="../backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li>

159
docs/build/html/backend/index.html vendored
View file

@ -40,7 +40,7 @@
<link rel="index" title="Indice" href="../genindex.html" /> <link rel="index" title="Indice" href="../genindex.html" />
<link rel="search" title="Cerca" href="../search.html" /> <link rel="search" title="Cerca" href="../search.html" />
<link rel="next" title="nest_crawler - Crawler in Python" href="../crawler/index.html" /> <link rel="next" title="nest_crawler - Crawler in Python" href="../crawler/index.html" />
<link rel="prev" title="Installazione" href="../installation/index.html" /> <link rel="prev" title="Meta-documentazione" href="../meta/index.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -85,11 +85,15 @@
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">Il progetto</a></li> <li class="toctree-l1"><a class="reference internal" href="../about/index.html">Il progetto</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installazione</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Meta-documentazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a><ul> <li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a><ul>
@ -224,8 +228,9 @@ It is required by Flask-JWT, and shouldnt be used alone.
<dl class="py function"> <dl class="py function">
<dt id="nest_backend.gestione.json_error"> <dt id="nest_backend.gestione.json_error">
<code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">json_error</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.json_error" title="Link a questa definizione"></a></dt> <code class="sig-prename descclassname"><span class="pre">nest_backend.gestione.</span></code><code class="sig-name descname"><span class="pre">json_error</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'errorUnknownError'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.gestione.json_error" title="Link a questa definizione"></a></dt>
<dd><p>Returns an error in json format <dd><p>Returns an error in json format
:param code: the code of the error according to the spec.
:param msg: the error message. :param msg: the error message.
:return: a json formatted string.</p> :return: a json formatted string.</p>
</dd></dl> </dd></dl>
@ -284,6 +289,11 @@ It is required by Flask-JWT, and shouldnt be used alone.
<code class="sig-name descname"><span class="pre">window_size</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.window_size" title="Link a questa definizione"></a></dt> <code class="sig-name descname"><span class="pre">window_size</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.window_size" title="Link a questa definizione"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.Alert.evaluation_mode">
<code class="sig-name descname"><span class="pre">evaluation_mode</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.evaluation_mode" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute"> <dl class="py attribute">
<dt id="nest_backend.database.tables.Alert.repository_id"> <dt id="nest_backend.database.tables.Alert.repository_id">
<code class="sig-name descname"><span class="pre">repository_id</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.repository_id" title="Link a questa definizione"></a></dt> <code class="sig-name descname"><span class="pre">repository_id</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.repository_id" title="Link a questa definizione"></a></dt>
@ -300,8 +310,8 @@ It is required by Flask-JWT, and shouldnt be used alone.
<dd></dd></dl> <dd></dd></dl>
<dl class="py attribute"> <dl class="py attribute">
<dt id="nest_backend.database.tables.Alert.operations"> <dt id="nest_backend.database.tables.Alert.conditions">
<code class="sig-name descname"><span class="pre">operations</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.operations" title="Link a questa definizione"></a></dt> <code class="sig-name descname"><span class="pre">conditions</span></code><a class="headerlink" href="#nest_backend.database.tables.Alert.conditions" title="Link a questa definizione"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py method"> <dl class="py method">
@ -361,100 +371,6 @@ for example, any mapped columns or relationships.</p>
</dd></dl> </dd></dl>
<dl class="py class">
<dt id="nest_backend.database.tables.BoolOperation">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.</span></code><code class="sig-name descname"><span class="pre">BoolOperation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.BoolOperation" title="Link a questa definizione"></a></dt>
<dd><blockquote>
<div><p>Basi: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
</div></blockquote>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.id">
<code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.id" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.operation">
<code class="sig-name descname"><span class="pre">operation</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.operation" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.is_root">
<code class="sig-name descname"><span class="pre">is_root</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.is_root" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.condition_id">
<code class="sig-name descname"><span class="pre">condition_id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.condition_id" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.node_1_id">
<code class="sig-name descname"><span class="pre">node_1_id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.node_1_id" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.node_2_id">
<code class="sig-name descname"><span class="pre">node_2_id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.node_2_id" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.alert_id">
<code class="sig-name descname"><span class="pre">alert_id</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.alert_id" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.condition">
<code class="sig-name descname"><span class="pre">condition</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.condition" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.node_1">
<code class="sig-name descname"><span class="pre">node_1</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.node_1" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.node_2">
<code class="sig-name descname"><span class="pre">node_2</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.node_2" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.alert">
<code class="sig-name descname"><span class="pre">alert</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.alert" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="nest_backend.database.tables.BoolOperation.to_json">
<code class="sig-name descname"><span class="pre">to_json</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.to_json" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="nest_backend.database.tables.BoolOperation.get_chain_ids">
<code class="sig-name descname"><span class="pre">get_chain_ids</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lista</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.get_chain_ids" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="nest_backend.database.tables.BoolOperation.__init__">
<code class="sig-name descname"><span class="pre">__init__</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.__init__" title="Link a questa definizione"></a></dt>
<dd><p>A simple constructor that allows initialization from kwargs.</p>
<p>Sets attributes on the constructed instance using the names and
values in <code class="docutils literal notranslate"><span class="pre">kwargs</span></code>.</p>
<p>Only keys that are present as
attributes of the instance’s class are allowed. These could be,
for example, any mapped columns or relationships.</p>
</dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.father_1">
<code class="sig-name descname"><span class="pre">father_1</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.father_1" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.BoolOperation.father_2">
<code class="sig-name descname"><span class="pre">father_2</span></code><a class="headerlink" href="#nest_backend.database.tables.BoolOperation.father_2" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class"> <dl class="py class">
<dt id="nest_backend.database.tables.Composed"> <dt id="nest_backend.database.tables.Composed">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.</span></code><code class="sig-name descname"><span class="pre">Composed</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Composed" title="Link a questa definizione"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.</span></code><code class="sig-name descname"><span class="pre">Composed</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.Composed" title="Link a questa definizione"></a></dt>
@ -531,8 +447,8 @@ for example, any mapped columns or relationships.</p>
<dd></dd></dl> <dd></dd></dl>
<dl class="py attribute"> <dl class="py attribute">
<dt id="nest_backend.database.tables.Condition.operations"> <dt id="nest_backend.database.tables.Condition.alerts">
<code class="sig-name descname"><span class="pre">operations</span></code><a class="headerlink" href="#nest_backend.database.tables.Condition.operations" title="Link a questa definizione"></a></dt> <code class="sig-name descname"><span class="pre">alerts</span></code><a class="headerlink" href="#nest_backend.database.tables.Condition.alerts" title="Link a questa definizione"></a></dt>
<dd></dd></dl> <dd></dd></dl>
<dl class="py method"> <dl class="py method">
@ -838,6 +754,45 @@ for example, any mapped columns or relationships.</p>
</dd></dl> </dd></dl>
<dl class="py class">
<dt id="nest_backend.database.tables.MadeOf">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.</span></code><code class="sig-name descname"><span class="pre">MadeOf</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.MadeOf" title="Link a questa definizione"></a></dt>
<dd><blockquote>
<div><p>Basi: <code class="xref py py-class docutils literal notranslate"><span class="pre">sqlalchemy.orm.decl_api.Model</span></code></p>
</div></blockquote>
<dl class="py attribute">
<dt id="nest_backend.database.tables.MadeOf.aid">
<code class="sig-name descname"><span class="pre">aid</span></code><a class="headerlink" href="#nest_backend.database.tables.MadeOf.aid" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.MadeOf.cid">
<code class="sig-name descname"><span class="pre">cid</span></code><a class="headerlink" href="#nest_backend.database.tables.MadeOf.cid" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.MadeOf.alert">
<code class="sig-name descname"><span class="pre">alert</span></code><a class="headerlink" href="#nest_backend.database.tables.MadeOf.alert" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="nest_backend.database.tables.MadeOf.condition">
<code class="sig-name descname"><span class="pre">condition</span></code><a class="headerlink" href="#nest_backend.database.tables.MadeOf.condition" title="Link a questa definizione"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="nest_backend.database.tables.MadeOf.__init__">
<code class="sig-name descname"><span class="pre">__init__</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.MadeOf.__init__" title="Link a questa definizione"></a></dt>
<dd><p>A simple constructor that allows initialization from kwargs.</p>
<p>Sets attributes on the constructed instance using the names and
values in <code class="docutils literal notranslate"><span class="pre">kwargs</span></code>.</p>
<p>Only keys that are present as
attributes of the instance’s class are allowed. These could be,
for example, any mapped columns or relationships.</p>
</dd></dl>
</dd></dl>
<dl class="py class"> <dl class="py class">
<dt id="nest_backend.database.tables.ConditionType"> <dt id="nest_backend.database.tables.ConditionType">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.</span></code><code class="sig-name descname"><span class="pre">ConditionType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.ConditionType" title="Link a questa definizione"></a></dt> <em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">nest_backend.database.tables.</span></code><code class="sig-name descname"><span class="pre">ConditionType</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.database.tables.ConditionType" title="Link a questa definizione"></a></dt>
@ -925,7 +880,7 @@ GitLab</a> .</p>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../crawler/index.html" class="btn btn-neutral float-right" title="nest_crawler - Crawler in Python" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="../crawler/index.html" class="btn btn-neutral float-right" title="nest_crawler - Crawler in Python" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../installation/index.html" class="btn btn-neutral float-left" title="Installazione" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="../meta/index.html" class="btn btn-neutral float-left" title="Meta-documentazione" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>

6
docs/build/html/crawler/index.html vendored
View file

@ -85,11 +85,15 @@
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">Il progetto</a></li> <li class="toctree-l1"><a class="reference internal" href="../about/index.html">Il progetto</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installazione</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Informazioni sulla documentazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li> <li class="toctree-l1"><a class="reference internal" href="../backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li>

6
docs/build/html/frontend/index.html vendored
View file

@ -84,11 +84,15 @@
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">Il progetto</a></li> <li class="toctree-l1"><a class="reference internal" href="../about/index.html">Il progetto</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installazione</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Informazioni sulla documentazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li> <li class="toctree-l1"><a class="reference internal" href="../backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li>

97
docs/build/html/genindex.html vendored
View file

@ -83,11 +83,15 @@
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li> <li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a></li> <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li> <li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li>
@ -164,7 +168,6 @@
<div class="genindex-jumpbox"> <div class="genindex-jumpbox">
<a href="#_"><strong>_</strong></a> <a href="#_"><strong>_</strong></a>
| <a href="#A"><strong>A</strong></a> | <a href="#A"><strong>A</strong></a>
| <a href="#B"><strong>B</strong></a>
| <a href="#C"><strong>C</strong></a> | <a href="#C"><strong>C</strong></a>
| <a href="#E"><strong>E</strong></a> | <a href="#E"><strong>E</strong></a>
| <a href="#F"><strong>F</strong></a> | <a href="#F"><strong>F</strong></a>
@ -191,14 +194,14 @@
<ul> <ul>
<li><a href="backend/index.html#nest_backend.database.tables.Authorization.__init__">(nest_backend.database.tables.Authorization metodo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Authorization.__init__">(nest_backend.database.tables.Authorization metodo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.__init__">(nest_backend.database.tables.BoolOperation metodo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Composed.__init__">(nest_backend.database.tables.Composed metodo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Composed.__init__">(nest_backend.database.tables.Composed metodo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Condition.__init__">(nest_backend.database.tables.Condition metodo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Condition.__init__">(nest_backend.database.tables.Condition metodo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Contains.__init__">(nest_backend.database.tables.Contains metodo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Contains.__init__">(nest_backend.database.tables.Contains metodo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.MadeOf.__init__">(nest_backend.database.tables.MadeOf metodo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Notification.__init__">(nest_backend.database.tables.Notification metodo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Notification.__init__">(nest_backend.database.tables.Notification metodo)</a>
</li> </li>
@ -216,23 +219,25 @@
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.gestione.admin_or_403">admin_or_403() (nel modulo nest_backend.gestione)</a> <li><a href="backend/index.html#nest_backend.gestione.admin_or_403">admin_or_403() (nel modulo nest_backend.gestione)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.MadeOf.aid">aid (nest_backend.database.tables.MadeOf attributo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Alert">Alert (classe in nest_backend.database.tables)</a> <li><a href="backend/index.html#nest_backend.database.tables.Alert">Alert (classe in nest_backend.database.tables)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.alert">alert (nest_backend.database.tables.BoolOperation attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.MadeOf.alert">alert (nest_backend.database.tables.MadeOf attributo)</a>
<ul> <ul>
<li><a href="backend/index.html#nest_backend.database.tables.Notification.alert">(nest_backend.database.tables.Notification attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Notification.alert">(nest_backend.database.tables.Notification attributo)</a>
</li> </li>
</ul></li> </ul></li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.alert_id">alert_id (nest_backend.database.tables.BoolOperation attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Notification.alert_id">alert_id (nest_backend.database.tables.Notification attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.Condition.alerts">alerts (nest_backend.database.tables.Condition attributo)</a>
<ul> <ul>
<li><a href="backend/index.html#nest_backend.database.tables.Notification.alert_id">(nest_backend.database.tables.Notification attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Repository.alerts">(nest_backend.database.tables.Repository attributo)</a>
</li> </li>
</ul></li> </ul></li>
<li><a href="backend/index.html#nest_backend.database.tables.Repository.alerts">alerts (nest_backend.database.tables.Repository attributo)</a>
</li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.ConditionMode.all_and">all_and (nest_backend.database.tables.ConditionMode attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.ConditionMode.all_and">all_and (nest_backend.database.tables.ConditionMode attributo)</a>
@ -254,38 +259,34 @@
</ul></td> </ul></td>
</tr></table> </tr></table>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation">BoolOperation (classe in nest_backend.database.tables)</a>
</li>
</ul></td>
</tr></table>
<h2 id="C">C</h2> <h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.Contains.cid">cid (nest_backend.database.tables.Contains attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Contains.cid">cid (nest_backend.database.tables.Contains attributo)</a>
<ul>
<li><a href="backend/index.html#nest_backend.database.tables.MadeOf.cid">(nest_backend.database.tables.MadeOf attributo)</a>
</li> </li>
</ul></li>
<li><a href="backend/index.html#nest_backend.database.tables.Composed">Composed (classe in nest_backend.database.tables)</a> <li><a href="backend/index.html#nest_backend.database.tables.Composed">Composed (classe in nest_backend.database.tables)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Condition">Condition (classe in nest_backend.database.tables)</a> <li><a href="backend/index.html#nest_backend.database.tables.Condition">Condition (classe in nest_backend.database.tables)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.condition">condition (nest_backend.database.tables.BoolOperation attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Contains.condition">condition (nest_backend.database.tables.Contains attributo)</a>
<ul> <ul>
<li><a href="backend/index.html#nest_backend.database.tables.Contains.condition">(nest_backend.database.tables.Contains attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.MadeOf.condition">(nest_backend.database.tables.MadeOf attributo)</a>
</li> </li>
</ul></li> </ul></li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.condition_id">condition_id (nest_backend.database.tables.BoolOperation attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.ConditionMode">ConditionMode (classe in nest_backend.database.tables)</a> <li><a href="backend/index.html#nest_backend.database.tables.ConditionMode">ConditionMode (classe in nest_backend.database.tables)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.Repository.conditions">conditions (nest_backend.database.tables.Repository attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Alert.conditions">conditions (nest_backend.database.tables.Alert attributo)</a>
<ul> <ul>
<li><a href="backend/index.html#nest_backend.database.tables.Repository.conditions">(nest_backend.database.tables.Repository attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.Tweet.conditions">(nest_backend.database.tables.Tweet attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Tweet.conditions">(nest_backend.database.tables.Tweet attributo)</a>
</li> </li>
</ul></li> </ul></li>
@ -313,26 +314,24 @@
<li><a href="backend/index.html#nest_backend.database.tables.User.email">(nest_backend.database.tables.User attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.User.email">(nest_backend.database.tables.User attributo)</a>
</li> </li>
</ul></li> </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.Repository.end">end (nest_backend.database.tables.Repository attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Repository.end">end (nest_backend.database.tables.Repository attributo)</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.gestione.error_handler">error_handler() (nel modulo nest_backend.gestione)</a> <li><a href="backend/index.html#nest_backend.gestione.error_handler">error_handler() (nel modulo nest_backend.gestione)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Repository.evaluation_mode">evaluation_mode (nest_backend.database.tables.Repository attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Alert.evaluation_mode">evaluation_mode (nest_backend.database.tables.Alert attributo)</a>
<ul>
<li><a href="backend/index.html#nest_backend.database.tables.Repository.evaluation_mode">(nest_backend.database.tables.Repository attributo)</a>
</li> </li>
</ul></li>
</ul></td> </ul></td>
</tr></table> </tr></table>
<h2 id="F">F</h2> <h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.father_1">father_1 (nest_backend.database.tables.BoolOperation attributo)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.father_2">father_2 (nest_backend.database.tables.BoolOperation attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.gestione.find_user">find_user() (nel modulo nest_backend.gestione)</a> <li><a href="backend/index.html#nest_backend.gestione.find_user">find_user() (nel modulo nest_backend.gestione)</a>
</li> </li>
</ul></td> </ul></td>
@ -342,10 +341,6 @@
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.gestione.gen_password">gen_password() (nel modulo nest_backend.gestione)</a> <li><a href="backend/index.html#nest_backend.gestione.gen_password">gen_password() (nel modulo nest_backend.gestione)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.get_chain_ids">get_chain_ids() (nest_backend.database.tables.BoolOperation metodo)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -368,8 +363,6 @@
<li><a href="backend/index.html#nest_backend.database.tables.Alert.id">id (nest_backend.database.tables.Alert attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Alert.id">id (nest_backend.database.tables.Alert attributo)</a>
<ul> <ul>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.id">(nest_backend.database.tables.BoolOperation attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.Condition.id">(nest_backend.database.tables.Condition attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Condition.id">(nest_backend.database.tables.Condition attributo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Notification.id">(nest_backend.database.tables.Notification attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Notification.id">(nest_backend.database.tables.Notification attributo)</a>
@ -384,8 +377,6 @@
<li><a href="backend/index.html#nest_backend.database.tables.Tweet.insert_time">insert_time (nest_backend.database.tables.Tweet attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Tweet.insert_time">insert_time (nest_backend.database.tables.Tweet attributo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Repository.is_active">is_active (nest_backend.database.tables.Repository attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Repository.is_active">is_active (nest_backend.database.tables.Repository attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.is_root">is_root (nest_backend.database.tables.BoolOperation attributo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.User.isAdmin">isAdmin (nest_backend.database.tables.User attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.User.isAdmin">isAdmin (nest_backend.database.tables.User attributo)</a>
</li> </li>
@ -425,6 +416,8 @@
<h2 id="M">M</h2> <h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.MadeOf">MadeOf (classe in nest_backend.database.tables)</a>
</li>
<li> <li>
modulo modulo
@ -473,6 +466,8 @@
<li><a href="backend/index.html#module-nest_backend.database.base">modulo</a> <li><a href="backend/index.html#module-nest_backend.database.base">modulo</a>
</li> </li>
</ul></li> </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li> <li>
nest_backend.database.tables nest_backend.database.tables
@ -480,8 +475,6 @@
<li><a href="backend/index.html#module-nest_backend.database.tables">modulo</a> <li><a href="backend/index.html#module-nest_backend.database.tables">modulo</a>
</li> </li>
</ul></li> </ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li> <li>
nest_backend.gestione nest_backend.gestione
@ -489,14 +482,6 @@
<li><a href="backend/index.html#module-nest_backend.gestione">modulo</a> <li><a href="backend/index.html#module-nest_backend.gestione">modulo</a>
</li> </li>
</ul></li> </ul></li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.node_1">node_1 (nest_backend.database.tables.BoolOperation attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.node_1_id">node_1_id (nest_backend.database.tables.BoolOperation attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.node_2">node_2 (nest_backend.database.tables.BoolOperation attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.node_2_id">node_2_id (nest_backend.database.tables.BoolOperation attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.Notification">Notification (classe in nest_backend.database.tables)</a> <li><a href="backend/index.html#nest_backend.database.tables.Notification">Notification (classe in nest_backend.database.tables)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Alert.notifications">notifications (nest_backend.database.tables.Alert attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Alert.notifications">notifications (nest_backend.database.tables.Alert attributo)</a>
@ -507,20 +492,12 @@
<h2 id="O">O</h2> <h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.operation">operation (nest_backend.database.tables.BoolOperation attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.Alert.operations">operations (nest_backend.database.tables.Alert attributo)</a>
<ul>
<li><a href="backend/index.html#nest_backend.database.tables.Condition.operations">(nest_backend.database.tables.Condition attributo)</a>
</li>
</ul></li>
<li><a href="backend/index.html#nest_backend.database.tables.OperationType">OperationType (classe in nest_backend.database.tables)</a> <li><a href="backend/index.html#nest_backend.database.tables.OperationType">OperationType (classe in nest_backend.database.tables)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.Notification.ora">ora (nest_backend.database.tables.Notification attributo)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="backend/index.html#nest_backend.database.tables.Notification.ora">ora (nest_backend.database.tables.Notification attributo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.Repository.owner">owner (nest_backend.database.tables.Repository attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Repository.owner">owner (nest_backend.database.tables.Repository attributo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Repository.owner_id">owner_id (nest_backend.database.tables.Repository attributo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Repository.owner_id">owner_id (nest_backend.database.tables.Repository attributo)</a>
@ -610,8 +587,6 @@
<li><a href="backend/index.html#nest_backend.database.tables.Alert.to_json">to_json() (nest_backend.database.tables.Alert metodo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Alert.to_json">to_json() (nest_backend.database.tables.Alert metodo)</a>
<ul> <ul>
<li><a href="backend/index.html#nest_backend.database.tables.BoolOperation.to_json">(nest_backend.database.tables.BoolOperation metodo)</a>
</li>
<li><a href="backend/index.html#nest_backend.database.tables.Condition.to_json">(nest_backend.database.tables.Condition metodo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Condition.to_json">(nest_backend.database.tables.Condition metodo)</a>
</li> </li>
<li><a href="backend/index.html#nest_backend.database.tables.Notification.to_json">(nest_backend.database.tables.Notification metodo)</a> <li><a href="backend/index.html#nest_backend.database.tables.Notification.to_json">(nest_backend.database.tables.Notification metodo)</a>

19
docs/build/html/index.html vendored
View file

@ -84,11 +84,15 @@
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li> <li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a></li> <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li> <li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li>
@ -165,7 +169,7 @@
<h1>N.E.S.T.<a class="headerlink" href="#n-e-s-t" title="Link a questa intestazione"></a></h1> <h1>N.E.S.T.<a class="headerlink" href="#n-e-s-t" title="Link a questa intestazione"></a></h1>
<p>Benvenuto alla documentazione di N.E.S.T.!</p> <p>Benvenuto alla documentazione di N.E.S.T.!</p>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li> <li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a><ul> <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a><ul>
@ -186,6 +190,17 @@
</ul> </ul>
</div> </div>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a><ul>
<li class="toctree-l2"><a class="reference internal" href="meta/index.html#compilazione-con-intellij-idea">Compilazione con IntelliJ IDEA</a></li>
<li class="toctree-l2"><a class="reference internal" href="meta/index.html#compilazione-con-gnu-make">Compilazione con GNU Make</a></li>
<li class="toctree-l2"><a class="reference internal" href="meta/index.html#compilazione-con-windows-powershell">Compilazione con Windows Powershell</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a><ul> <li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a><ul>

16
docs/build/html/installation/index.html vendored
View file

@ -39,7 +39,7 @@
<link rel="index" title="Indice" href="../genindex.html" /> <link rel="index" title="Indice" href="../genindex.html" />
<link rel="search" title="Cerca" href="../search.html" /> <link rel="search" title="Cerca" href="../search.html" />
<link rel="next" title="nest_backend - Web API in Python" href="../backend/index.html" /> <link rel="next" title="Informazioni sulla documentazione" href="../meta/index.html" />
<link rel="prev" title="Il progetto" href="../about/index.html" /> <link rel="prev" title="Il progetto" href="../about/index.html" />
</head> </head>
@ -85,7 +85,7 @@
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">Il progetto</a></li> <li class="toctree-l1"><a class="reference internal" href="../about/index.html">Il progetto</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installazione</a><ul> <li class="toctree-l1 current"><a class="current reference internal" href="#">Installazione</a><ul>
@ -104,6 +104,10 @@
</ul> </ul>
</li> </li>
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Informazioni sulla documentazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li> <li class="toctree-l1"><a class="reference internal" href="../backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li>
@ -236,7 +240,7 @@ Si veda il manuale di <a class="reference external" href="https://linux.die.net/
</div> </div>
<div class="section" id="creare-un-file-di-configurazione-per-il-backend"> <div class="section" id="creare-un-file-di-configurazione-per-il-backend">
<h2>Creare un file di configurazione per il backend<a class="headerlink" href="#creare-un-file-di-configurazione-per-il-backend" title="Link a questa intestazione"></a></h2> <h2>Creare un file di configurazione per il backend<a class="headerlink" href="#creare-un-file-di-configurazione-per-il-backend" title="Link a questa intestazione"></a></h2>
<p>Il backend usa un file di configurazione per impostare certe variabili.</p> <p>Il backend usa un file di configurazione per impostare alcune variabili.</p>
<p>Si crei un nuovo file nella working directory del progetto denominato <code class="docutils literal notranslate"><span class="pre">config.py</span></code>:</p> <p>Si crei un nuovo file nella working directory del progetto denominato <code class="docutils literal notranslate"><span class="pre">config.py</span></code>:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">nest:~/g2-progetto$ </span>vim config.py <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">nest:~/g2-progetto$ </span>vim config.py
</pre></div> </pre></div>
@ -261,8 +265,8 @@ Si veda il manuale di <a class="reference external" href="https://linux.die.net/
</div> </div>
<p>Poetry creerà automaticamente un <a class="reference external" href="https://docs.python.org/3/library/venv.html">venv</a> e vi installerà all’interno tutti <p>Poetry creerà automaticamente un <a class="reference external" href="https://docs.python.org/3/library/venv.html">venv</a> e vi installerà all’interno tutti
i pacchetti necessari all’esecuzione del backend e del crawler di N.E.S.T. .</p> i pacchetti necessari all’esecuzione del backend e del crawler di N.E.S.T. .</p>
<p><strong>Segnatevi il nome</strong> del venv creato da Poetry, in quanto sarà necessario per <p><strong>Si suggerisce di ricordare il nome del venv creato da Poetry</strong>, in quanto sarà necessario per
<span class="xref std std-ref">Creare un servizio SystemD per il backend</span>:</p> <a class="reference internal" href="#creare-un-servizio-systemd-per-il-backend"><span class="std std-ref">Creare un servizio SystemD per il backend</span></a>:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">Creating virtualenv nest-7C2fm2VD-py3.9 in /srv/nest/.cache/pypoetry/virtualenvs</span> <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">Creating virtualenv nest-7C2fm2VD-py3.9 in /srv/nest/.cache/pypoetry/virtualenvs</span>
</pre></div> </pre></div>
</div> </div>
@ -452,7 +456,7 @@ esempio da adattare al proprio setup:</p>
</div> </div>
<footer> <footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../backend/index.html" class="btn btn-neutral float-right" title="nest_backend - Web API in Python" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> <a href="../meta/index.html" class="btn btn-neutral float-right" title="Informazioni sulla documentazione" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../about/index.html" class="btn btn-neutral float-left" title="Il progetto" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="../about/index.html" class="btn btn-neutral float-left" title="Il progetto" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>

BIN
docs/build/html/objects.inv vendored
View file

Binary file not shown.

6
docs/build/html/py-modindex.html vendored
View file

@ -86,11 +86,15 @@
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li> <li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a></li> <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li> <li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li>

6
docs/build/html/search.html vendored
View file

@ -86,11 +86,15 @@
<p class="caption"><span class="caption-text">Manuale</span></p> <p class="caption"><span class="caption-text">Manuale utente</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li> <li class="toctree-l1"><a class="reference internal" href="about/index.html">Il progetto</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a></li> <li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p> <p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li> <li class="toctree-l1"><a class="reference internal" href="backend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_backend</span></code> - Web API in Python</a></li>

2
docs/build/html/searchindex.js vendored
View file

File diff suppressed because one or more lines are too long

3
docs/source/conf.py
View file

@ -32,7 +32,8 @@ release = '0.1.0'
extensions = [ extensions = [
"sphinx.ext.autodoc", "sphinx.ext.autodoc",
"sphinx.ext.intersphinx", "sphinx.ext.intersphinx",
'sphinx.ext.todo', "sphinx.ext.todo",
"sphinx.ext.autosectionlabel",
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.

9
docs/source/index.rst
View file

@ -5,12 +5,19 @@ Benvenuto alla documentazione di N.E.S.T.!
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Manuale :caption: Manuale utente
about/index about/index
installation/index installation/index
.. toctree::
:maxdepth: 2
:caption: Guida sviluppatore
meta/index
.. toctree:: .. toctree::
:caption: Documentazione autogenerata :caption: Documentazione autogenerata

4
docs/source/installation/index.rst
View file

@ -113,8 +113,8 @@ Le dipendenze Python sono gestite da *Poetry*, e possono essere installate con:
Poetry creerà automaticamente un `venv <https://docs.python.org/3/library/venv.html>`_ e vi installerà all'interno tutti Poetry creerà automaticamente un `venv <https://docs.python.org/3/library/venv.html>`_ e vi installerà all'interno tutti
i pacchetti necessari all'esecuzione del backend e del crawler di N.E.S.T. . i pacchetti necessari all'esecuzione del backend e del crawler di N.E.S.T. .
**Segnatevi il nome** del venv creato da Poetry, in quanto sarà necessario per **Si suggerisce di ricordare il nome del venv creato da Poetry**, in quanto sarà necessario per
:ref:`creare un servizio SystemD per il backend`: :ref:`Creare un servizio SystemD per il backend`:
.. code-block:: console .. code-block:: console

BIN
docs/source/meta/docsRunConfig.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 3 KiB

84
docs/source/meta/index.rst Normal file
View file

@ -0,0 +1,84 @@
Meta-documentazione
===================
La documentazione è scritta in `reStructuredText <https://docutils.sourceforge.io/rst.html>`_, ed è generata con
`Sphinx <https://www.sphinx-doc.org/en/master/>`_.
I dati relativi alla documentazione si trovano nella directory standard ``/docs``;
in particolare, le sorgenti reStructuredText si trovano in ``/docs/source``,
mentre l'ultima versione compilata si trova in ``/docs/build``.
Questa struttura permetterebbe l'integrazione con lo strumento di "Continuous Documentation"
`ReadTheDocs <https://readthedocs.com/>`_, qualora il progetto fosse ospitato su GitHub o disponessimo di una licenza
almeno `Basic <https://readthedocs.com/pricing/>`_.
Compilazione con IntelliJ IDEA
------------------------------
È possibile compilare manualmente la documentazione con IntelliJ IDEA.
Su sistemi Linux, è disponibile la Run Configuration ``Docs``, che compilerà la versione HTML della documentazione se
eseguita.
.. image:: docsRunConfig.png
Compilazione con GNU Make
-------------------------
È possibile compilare manualmente la documentazione con GNU Make.
Come prima cosa, è necessario :ref:`Installare le dipendenze Python` del progetto:
.. code-block:: console
user:g2-progetto$ poetry install
Poi, si entri all'interno del virtual environment:
.. code-block:: console
user:g2-progetto$ poetry shell
Una volta all'interno del venv, si entri nella cartella della documentazione:
.. code-block:: console
user:g2-progetto$ cd docs
Infine, si esegua il target ``html`` del Makefile:
.. code-block:: console
user:g2-progetto/docs$ make html
Compilazione con Windows Powershell
-----------------------------------
È possibile compilare manualmente la documentazione con Windows Powershell.
Come prima cosa, è necessario :ref:`Installare le dipendenze Python` del progetto:
.. code-block:: doscon
g2-progetto> poetry install
Poi, si entri all'interno del virtual environment:
.. code-block:: doscon
g2-progetto> poetry shell
Una volta all'interno del venv, si entri nella cartella della documentazione:
.. code-block:: doscon
g2-progetto> cd docs
Infine, si esegua lo script ``make.bat`` con il parametro ``html``:
.. code-block:: doscon
g2-progetto/docs> make html

4
legacy/doc/checklists/README.md
View file

@ -1,4 +0,0 @@
# Checklists
Le checklist con tutte le cose da fare (relative a Progetto del Software, non al prodotto) ad ogni Sprint saranno
disponibili qui.

8
legacy/doc/howToSphinx.md
View file

@ -1,8 +0,0 @@
# Guida per sphinx
- Crea la cartella docs
- Entra nella cartella docs
- sphinx-quickstart --ext-autodoc
- Segui la procedura
- Modifica l'rst aggiungendo "modules" sotto la struttura ad albero e modifica config.py in modo che il path faccia
riferimento alla parent directory
- make html

30
package-lock.json generated
View file

@ -21,11 +21,9 @@
"classnames": "^2.3.1", "classnames": "^2.3.1",
"is-string": "^1.0.5", "is-string": "^1.0.5",
"leaflet": "^1.7.1", "leaflet": "^1.7.1",
"localized-strings": "github:Steffo99/localized-strings",
"react": "^17.0.2", "react": "^17.0.2",
"react-dom": "^17.0.2", "react-dom": "^17.0.2",
"react-leaflet": ">=3.1.0 <3.2.0 || ^3.2.1", "react-leaflet": ">=3.1.0 <3.2.0 || ^3.2.1",
"react-localization": "^1.0.17",
"react-router": "^5.2.0", "react-router": "^5.2.0",
"react-router-dom": "^5.2.0", "react-router-dom": "^5.2.0",
"react-scripts": "4.0.3", "react-scripts": "4.0.3",
@ -12720,11 +12718,6 @@
"node": ">=8.9.0" "node": ">=8.9.0"
} }
}, },
"node_modules/localized-strings": {
"version": "0.2.4",
"resolved": "git+ssh://git@github.com/Steffo99/localized-strings.git#bf6d078ba2b2264cac05fc6f61900e5752740da6",
"license": "MIT"
},
"node_modules/locate-path": { "node_modules/locate-path": {
"version": "6.0.0", "version": "6.0.0",
"resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz",
@ -16476,17 +16469,6 @@
"react-dom": "^17.0.1" "react-dom": "^17.0.1"
} }
}, },
"node_modules/react-localization": {
"version": "1.0.17",
"resolved": "https://registry.npmjs.org/react-localization/-/react-localization-1.0.17.tgz",
"integrity": "sha512-UowuLAvnEPXJgzxjDX/9hKdKYvtUgC6hQ5PV0CnT5f/77tItIUru5tTwgrDY2UL5oUK3JRMgz42tqnAU2W5eoA==",
"dependencies": {
"localized-strings": "^0.2.0"
},
"peerDependencies": {
"react": "^17.0.0 || ^16.0.0 || ^15.6.0"
}
},
"node_modules/react-refresh": { "node_modules/react-refresh": {
"version": "0.8.3", "version": "0.8.3",
"resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.8.3.tgz", "resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.8.3.tgz",
@ -32601,10 +32583,6 @@
"json5": "^2.1.2" "json5": "^2.1.2"
} }
}, },
"localized-strings": {
"version": "git+ssh://git@github.com/Steffo99/localized-strings.git#bf6d078ba2b2264cac05fc6f61900e5752740da6",
"from": "localized-strings@github:Steffo99/localized-strings"
},
"locate-path": { "locate-path": {
"version": "6.0.0", "version": "6.0.0",
"resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz",
@ -35590,14 +35568,6 @@
"@react-leaflet/core": "^1.0.2" "@react-leaflet/core": "^1.0.2"
} }
}, },
"react-localization": {
"version": "1.0.17",
"resolved": "https://registry.npmjs.org/react-localization/-/react-localization-1.0.17.tgz",
"integrity": "sha512-UowuLAvnEPXJgzxjDX/9hKdKYvtUgC6hQ5PV0CnT5f/77tItIUru5tTwgrDY2UL5oUK3JRMgz42tqnAU2W5eoA==",
"requires": {
"localized-strings": "^0.2.0"
}
},
"react-refresh": { "react-refresh": {
"version": "0.8.3", "version": "0.8.3",
"resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.8.3.tgz", "resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.8.3.tgz",