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

📔 Continue porting docs to the new format

This commit is contained in:
Steffo 2021-05-18 04:18:30 +02:00
parent bab5d7235c
commit 893ccd251c
Signed by: steffo
GPG key ID: 6965406171929D01
38 changed files with 1547 additions and 31 deletions

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
docs/build/doctrees/meta/index.doctree vendored Normal file

Binary file not shown.

View file

@ -1,4 +1,4 @@
# Sphinx build info version 1 # Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 697fdcf2a865ef95bc825235d33ec5a4 config: 1567c588e515e4bb5e7b4b124607e7dc
tags: 645f666f9bcd5a90fca523b33c5a78b7 tags: 645f666f9bcd5a90fca523b33c5a78b7

Binary file not shown.

After

Width:  |  Height:  |  Size: 3 KiB

View file

@ -1,2 +1,4 @@
``nest_crawler`` - Crawler in Python ``nest_crawler`` - Crawler in Python
==================================== ====================================
.. automodule:: nest_crawler

View file

@ -0,0 +1,3 @@
Strumenti utilizzati
====================

View file

@ -18,6 +18,16 @@ Benvenuto alla documentazione di N.E.S.T.!
meta/index meta/index
.. toctree::
:maxdepth: 2
:caption: Compendio del progetto
development/client/index
development/stats/index
development/log
development/tools
.. toctree:: .. toctree::
:caption: Documentazione autogenerata :caption: Documentazione autogenerata

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

View file

@ -50,7 +50,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" style="background: #3B7097" >
@ -92,7 +92,7 @@
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p> <p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Informazioni sulla documentazione</a></li> <li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Meta-documentazione</a></li>
</ul> </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>

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="Meta-documentazione" href="../meta/index.html" /> <link rel="prev" title="Strumenti utilizzati" href="../development/tools.html" />
</head> </head>
<body class="wy-body-for-nav"> <body class="wy-body-for-nav">
@ -50,7 +50,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" style="background: #3B7097" >
@ -94,6 +94,13 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Meta-documentazione</a></li> <li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Meta-documentazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Compendio del progetto</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../development/client/index.html">Feedback ricevuto dal cliente</a></li>
<li class="toctree-l1"><a class="reference internal" href="../development/stats/index.html">Statistiche di Gitinspector</a></li>
<li class="toctree-l1"><a class="reference internal" href="../development/log.html">Registro attività</a></li>
<li class="toctree-l1"><a class="reference internal" href="../development/tools.html">Strumenti utilizzati</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>
@ -880,7 +887,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="../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> <a href="../development/tools.html" class="btn btn-neutral float-left" title="Strumenti utilizzati" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div> </div>
<hr/> <hr/>

View file

@ -50,7 +50,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" style="background: #3B7097" >
@ -92,7 +92,7 @@
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p> <p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Informazioni sulla documentazione</a></li> <li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Meta-documentazione</a></li>
</ul> </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">
@ -166,8 +166,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody"> <div itemprop="articleBody">
<div class="section" id="nest-crawler-crawler-in-python"> <div class="section" id="module-nest_crawler">
<h1><code class="docutils literal notranslate"><span class="pre">nest_crawler</span></code> - Crawler in Python<a class="headerlink" href="#nest-crawler-crawler-in-python" title="Link a questa intestazione"></a></h1> <span id="nest-crawler-crawler-in-python"></span><h1><code class="docutils literal notranslate"><span class="pre">nest_crawler</span></code> - Crawler in Python<a class="headerlink" href="#module-nest_crawler" title="Link a questa intestazione"></a></h1>
</div> </div>

225
docs/build/html/development/tools.html vendored Normal file
View file

@ -0,0 +1,225 @@
<!DOCTYPE html>
<html class="writer-html5" lang="it" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Strumenti utilizzati &mdash; N.E.S.T. 0.1.0 documentazione</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/translations.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Indice" href="../genindex.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="prev" title="Meta-documentazione" href="../meta/index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: #3B7097" >
<a href="../index.html" class="icon icon-home"> N.E.S.T.
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Manuale utente</span></p>
<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="../installation/index.html">Installazione</a></li>
</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">Compendio del progetto</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Strumenti utilizzati</a></li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<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="../crawler/index.html"><code class="docutils literal notranslate"><span class="pre">nest_crawler</span></code> - Crawler in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../frontend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_frontend</span></code> - Interfaccia utente in React</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">N.E.S.T.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>Strumenti utilizzati</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/development/tools.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="strumenti-utilizzati">
<h1>Strumenti utilizzati<a class="headerlink" href="#strumenti-utilizzati" title="Link a questa intestazione"></a></h1>
</div>
</div>
</div>
<footer>
<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-left" title="Meta-documentazione" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Gruppo 2.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View file

@ -49,7 +49,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" style="background: #3B7097" >
@ -91,7 +91,7 @@
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p> <p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Informazioni sulla documentazione</a></li> <li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Meta-documentazione</a></li>
</ul> </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">

View file

@ -48,7 +48,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" style="background: #3B7097" >
@ -92,6 +92,13 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li> <li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Compendio del progetto</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="development/client/index.html">Feedback ricevuto dal cliente</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/stats/index.html">Statistiche di Gitinspector</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/log.html">Registro attività</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/tools.html">Strumenti utilizzati</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>
@ -431,6 +438,8 @@
<li><a href="backend/index.html#module-nest_backend.database.tables">nest_backend.database.tables</a> <li><a href="backend/index.html#module-nest_backend.database.tables">nest_backend.database.tables</a>
</li> </li>
<li><a href="backend/index.html#module-nest_backend.gestione">nest_backend.gestione</a> <li><a href="backend/index.html#module-nest_backend.gestione">nest_backend.gestione</a>
</li>
<li><a href="crawler/index.html#module-nest_crawler">nest_crawler</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -480,6 +489,13 @@
<ul> <ul>
<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>
</ul></li>
<li>
nest_crawler
<ul>
<li><a href="crawler/index.html#module-nest_crawler">modulo</a>
</li> </li>
</ul></li> </ul></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>

View file

@ -49,7 +49,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" style="background: #3B7097" >
@ -93,6 +93,13 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li> <li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Compendio del progetto</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="development/client/index.html">Feedback ricevuto dal cliente</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/stats/index.html">Statistiche di Gitinspector</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/log.html">Registro attività</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/tools.html">Strumenti utilizzati</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>
@ -201,6 +208,25 @@
</ul> </ul>
</div> </div>
<div class="toctree-wrapper compound"> <div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Compendio del progetto</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="development/client/index.html">Feedback ricevuto dal cliente</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/client/index.html#documenti">Documenti</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/client/index.html#consegna-degli-sprint">Consegna degli Sprint</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development/stats/index.html">Statistiche di Gitinspector</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/log.html">Registro attività</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development/log.html#sprint-0">Sprint 0</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/log.html#sprint-1">Sprint 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/log.html#sprint-2">Sprint 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="development/log.html#sprint-3">Sprint 3</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development/tools.html">Strumenti utilizzati</a></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>

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="Informazioni sulla documentazione" href="../meta/index.html" /> <link rel="next" title="Meta-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>
@ -50,7 +50,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" style="background: #3B7097" >
@ -106,7 +106,7 @@
</ul> </ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p> <p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Informazioni sulla documentazione</a></li> <li class="toctree-l1"><a class="reference internal" href="../meta/index.html">Meta-documentazione</a></li>
</ul> </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>
@ -456,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="../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="../meta/index.html" class="btn btn-neutral float-right" title="Meta-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>

281
docs/build/html/meta/index.html vendored Normal file
View file

@ -0,0 +1,281 @@
<!DOCTYPE html>
<html class="writer-html5" lang="it" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Meta-documentazione &mdash; N.E.S.T. 0.1.0 documentazione</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/translations.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Indice" href="../genindex.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="prev" title="Installazione" href="../installation/index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: #3B7097" >
<a href="../index.html" class="icon icon-home"> N.E.S.T.
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Manuale utente</span></p>
<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="../installation/index.html">Installazione</a></li>
</ul>
<p class="caption"><span class="caption-text">Guida sviluppatore</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Meta-documentazione</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#compilazione-con-intellij-idea">Compilazione con IntelliJ IDEA</a></li>
<li class="toctree-l2"><a class="reference internal" href="#compilazione-con-gnu-make">Compilazione con GNU Make</a></li>
<li class="toctree-l2"><a class="reference internal" href="#compilazione-con-windows-powershell">Compilazione con Windows Powershell</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Documentazione autogenerata</span></p>
<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="../crawler/index.html"><code class="docutils literal notranslate"><span class="pre">nest_crawler</span></code> - Crawler in Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="../frontend/index.html"><code class="docutils literal notranslate"><span class="pre">nest_frontend</span></code> - Interfaccia utente in React</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">N.E.S.T.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>Meta-documentazione</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/meta/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="meta-documentazione">
<h1>Meta-documentazione<a class="headerlink" href="#meta-documentazione" title="Link a questa intestazione"></a></h1>
<p>La documentazione è scritta in <a class="reference external" href="https://docutils.sourceforge.io/rst.html">reStructuredText</a>, ed è generata con
<a class="reference external" href="https://www.sphinx-doc.org/en/master/">Sphinx</a>.</p>
<p>I dati relativi alla documentazione si trovano nella directory standard <code class="docutils literal notranslate"><span class="pre">/docs</span></code>;
in particolare, le sorgenti reStructuredText si trovano in <code class="docutils literal notranslate"><span class="pre">/docs/source</span></code>,
mentre lultima versione compilata si trova in <code class="docutils literal notranslate"><span class="pre">/docs/build</span></code>.</p>
<p>Questa struttura permetterebbe lintegrazione con lo strumento di «Continuous Documentation»
<a class="reference external" href="https://readthedocs.com/">ReadTheDocs</a>, qualora il progetto fosse ospitato su GitHub o disponessimo di una licenza
almeno <a class="reference external" href="https://readthedocs.com/pricing/">Basic</a>.</p>
<div class="section" id="compilazione-con-intellij-idea">
<h2>Compilazione con IntelliJ IDEA<a class="headerlink" href="#compilazione-con-intellij-idea" title="Link a questa intestazione"></a></h2>
<p>È possibile compilare manualmente la documentazione con IntelliJ IDEA.</p>
<p>Su sistemi Linux, è disponibile la Run Configuration <code class="docutils literal notranslate"><span class="pre">Docs</span></code>, che compilerà la versione HTML della documentazione se
eseguita.</p>
<img alt="../_images/docsRunConfig.png" src="../_images/docsRunConfig.png" />
</div>
<div class="section" id="compilazione-con-gnu-make">
<h2>Compilazione con GNU Make<a class="headerlink" href="#compilazione-con-gnu-make" title="Link a questa intestazione"></a></h2>
<p>È possibile compilare manualmente la documentazione con GNU Make.</p>
<p>Come prima cosa, è necessario <a class="reference internal" href="../installation/index.html#installare-le-dipendenze-python"><span class="std std-ref">Installare le dipendenze Python</span></a> del progetto:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">user:g2-progetto$ </span>poetry install
</pre></div>
</div>
<p>Poi, si entri allinterno del virtual environment:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">user:g2-progetto$ </span>poetry shell
</pre></div>
</div>
<p>Una volta allinterno del venv, si entri nella cartella della documentazione:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">user:g2-progetto$ </span><span class="nb">cd</span> docs
</pre></div>
</div>
<p>Infine, si esegua il target <code class="docutils literal notranslate"><span class="pre">html</span></code> del Makefile:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">user:g2-progetto/docs$ </span>make html
</pre></div>
</div>
</div>
<div class="section" id="compilazione-con-windows-powershell">
<h2>Compilazione con Windows Powershell<a class="headerlink" href="#compilazione-con-windows-powershell" title="Link a questa intestazione"></a></h2>
<p>È possibile compilare manualmente la documentazione con Windows Powershell.</p>
<p>Come prima cosa, è necessario <a class="reference internal" href="../installation/index.html#installare-le-dipendenze-python"><span class="std std-ref">Installare le dipendenze Python</span></a> del progetto:</p>
<div class="highlight-doscon notranslate"><div class="highlight"><pre><span></span><span class="gp">g2-progetto&gt;</span> poetry install
</pre></div>
</div>
<p>Poi, si entri allinterno del virtual environment:</p>
<div class="highlight-doscon notranslate"><div class="highlight"><pre><span></span><span class="gp">g2-progetto&gt;</span> poetry shell
</pre></div>
</div>
<p>Una volta allinterno del venv, si entri nella cartella della documentazione:</p>
<div class="highlight-doscon notranslate"><div class="highlight"><pre><span></span><span class="gp">g2-progetto&gt;</span> <span class="k">cd</span> docs
</pre></div>
</div>
<p>Infine, si esegua lo script <code class="docutils literal notranslate"><span class="pre">make.bat</span></code> con il parametro <code class="docutils literal notranslate"><span class="pre">html</span></code>:</p>
<div class="highlight-doscon notranslate"><div class="highlight"><pre><span></span><span class="gp">g2-progetto/docs&gt;</span> make html
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<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="../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>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Gruppo 2.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

Binary file not shown.

View file

@ -51,7 +51,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" style="background: #3B7097" >
@ -95,6 +95,13 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li> <li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Compendio del progetto</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="development/client/index.html">Feedback ricevuto dal cliente</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/stats/index.html">Statistiche di Gitinspector</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/log.html">Registro attività</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/tools.html">Strumenti utilizzati</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>
@ -200,6 +207,11 @@
<td>&#160;&#160;&#160; <td>&#160;&#160;&#160;
<a href="backend/index.html#module-nest_backend.gestione"><code class="xref">nest_backend.gestione</code></a></td><td> <a href="backend/index.html#module-nest_backend.gestione"><code class="xref">nest_backend.gestione</code></a></td><td>
<em></em></td></tr> <em></em></td></tr>
<tr>
<td></td>
<td>
<a href="crawler/index.html#module-nest_crawler"><code class="xref">nest_crawler</code></a></td><td>
<em></em></td></tr>
</table> </table>

View file

@ -51,7 +51,7 @@
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> <nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll"> <div class="wy-side-scroll">
<div class="wy-side-nav-search" > <div class="wy-side-nav-search" style="background: #3B7097" >
@ -95,6 +95,13 @@
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li> <li class="toctree-l1"><a class="reference internal" href="meta/index.html">Meta-documentazione</a></li>
</ul> </ul>
<p class="caption"><span class="caption-text">Compendio del progetto</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="development/client/index.html">Feedback ricevuto dal cliente</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/stats/index.html">Statistiche di Gitinspector</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/log.html">Registro attività</a></li>
<li class="toctree-l1"><a class="reference internal" href="development/tools.html">Strumenti utilizzati</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>

File diff suppressed because one or more lines are too long

View file

@ -64,12 +64,18 @@ nitpicky = True
# a list of builtin themes. # a list of builtin themes.
html_theme = 'sphinx_rtd_theme' html_theme = 'sphinx_rtd_theme'
html_theme_options = {
"style_nav_header_background": "#3B7097"
}
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
# -- Intersphinx options ----------------------------------------------------- # -- Intersphinx options -----------------------------------------------------
intersphinx_mapping = { intersphinx_mapping = {

View file

@ -1,2 +1,4 @@
``nest_crawler`` - Crawler in Python ``nest_crawler`` - Crawler in Python
==================================== ====================================
.. automodule:: nest_crawler

View file

@ -0,0 +1,20 @@
Feedback ricevuto dal cliente
=============================
Documenti
---------
- :download:`Descrizione iniziale del prodotto <0-initial.pdf>`
Consegna degli Sprint
---------------------
.. todo::
Aggiungere i documenti degli sprint mancanti!
- :download:`Sprint 0 <0-sprint-requirements.pdf>`
- :download:`Sprint 1`
- :download:`Sprint 2`
- :download:`Sprint 3`

View file

@ -0,0 +1,792 @@
Registro attività
=================
.. todo::
Mettere titoli personali uguali in tutti gli sprint per consistenza.
Sprint 0
--------
Riunioni collettive
^^^^^^^^^^^^^^^^^^^
.. list-table::
:header-rows: 1
* - Data
- Ora
- Durata
- Attività
* - 2021-04-08
- 20:45
- 1h
- Analisi documento di specifiche
* - 2021-04-09
- 14:15
- 35m
- Intervista con il cliente
* - 2021-04-09
- 15:00
- 1h
- Resoconto intervista
* - 2021-04-11
- 15:03
- 2h 39m
- Documentazione e planning poker
* - 2021-04-15
- 18:15
- 52m
- Documentazione
* - 2021-04-17
- 15:05
- 4h
- Documentazione e partita a Scrumble
Attività individuali
^^^^^^^^^^^^^^^^^^^^
Stefano Goldoni - Product Owner
"""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 1
* - Data
- Durata
- Attività
* - 2021-04-08
- 1.0h
- user stories
* - 2021-04-09
- 1.0h
- epic
* - 2021-04-10
- 0.5h
- use cases
* - 2021-04-11
- 0.5h
- use cases
* - 2021-04-14
- 0.5h
- documentazione SRS
* - 2021-04-15
- 0.5h
- documentazione SRS
* - 2021-04-17
- 1.5h
- diagrammi di attività
Flavia Cocca - Scrum Master
"""""""""""""""""""""""""""
.. list-table::
:header-rows: 1
* - Data
- Durata
- Attività
* - 2021-04-08
- 2.5h
- brainstorming Ui
* - 2021-04-10
- 2.0h
- creazione frame in figma con relativo css
* - 2021-04-11
- 1.5h
- mockup UI con relativo css (creazione componenti)
* - 2021-04-12
- 1.5h
- mockup UI con relativo css (creazione componenti)
* - 2021-04-14
- 3.0h
- mockup UI con relativo css (creazione pagine)
* - 2021-04-15
- 2.0h
- mockup UI con relativo css (creazioni pagine)
* - 2021-04-16
- 2.0h
- ultimi ritocchi UI
* - 2021-04-17
- 0.5h
- Stesura documentazione partita scrumble
Chiara Calzolari - UI/UX Designer
"""""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 1
* - Data
- Durata
- Attività
* - 2021-04-09
- 2.5h
- Brainstorming UI
* - 2021-04-10
- 1.5h
- mockup UI con relativo css (dashboard ed elenco repositories)
* - 2021-04-11
- 1.0h
- mockup UI con relativo css (settings)
* - 2021-04-11
- 0.5h
- Prima versione del logo
* - 2021-04-12
- 3.0h
- mockup UI con relativo css (creazione componenti, light/dark mode)
* - 2021-04-13
- 1.0h
- mockup UI con relativo css (alerts)
* - 2021-04-15
- 1.0h
- Versione definitiva del logo
* - 2021-04-16
- 0.5h
- mockup UI con relativo css (Notifications e Share)
* - 2021-04-17
- 1.0h
- Documentazione Mockup
* - 2021-04-17
- 0.5h
- Doppiaggio video di presentazione
Stefano Pigozzi - Frontend Developer & Sysadmin
"""""""""""""""""""""""""""""""""""""""""""""""
.. todo:: Compilare con i dati di Toggl!
Sprint 1
--------
Riunioni collettive
^^^^^^^^^^^^^^^^^^^
.. list-table::
:header-rows: 1
* - Data
- Ora
- Durata
- Attività
* - 2021-05-01
- 15:30
- 2h
- backlog grooming session
Attività individuali
^^^^^^^^^^^^^^^^^^^^
Stefano Goldoni - Product Owner
"""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 1
* - Data
- Durata
- Attività
* - 2021-04-20
- 0.5h
- analisi test
* - 2021-04-20
- 1.5h
- scrittura test cases
* - 2021-04-26
- 0.5h
- predisposizione progetto in locale per il test
* - 2021-04-26
- 2.0h
- metodi di test login e creazione utente
* - 2021-04-28
- 2.0h
- metodi ti test
* - 2021-04-29
- 2.0h
- metodi di test
* - 2021-04-30
- 2.0h
- metodi di test backend
* - 2021-05-01
- 1.0h
- test frontend
* - 2021-05-01
- 1.0h
- test backend in pair programming
* - 2021-05-02
- 1.0h
- documentazione
* - 2021-05-02
- 2.5h
- test backend
Giovanni Anniballi - Tester
"""""""""""""""""""""""""""
Per il lavoro di testing è stata utilizzata anche la tecnica del Pair Programming, grazie ad un plugin dell'IDE utilizzato.
.. list-table::
:header-rows: 1
* - Data
- Durata
- Attività
* - 2021-04-22
- 0.5h
- Riunione con il team
* - 2021-04-23
- 1.0h
- Studio struttura del backend
* - 2021-04-24
- 1.5h
- Studio del backend, volto a capire il funzionamento delle varie API
* - 2021-04-26
- 2.0h
- Testing login e retrieval dei dati inerenti a tutti gli utenti registrati
* - 2021-04-27
- 1.0h
- Testing creazione user
* - 2021-04-28
- 2.0h
- Test cancellazione utente e ritorno dei dati inerenti a quellutente
* - 2021-04-29
- 1.5h
- Test modica utenti e creazione della prima repository
* - 2021-04-30
- 2.0h
- Testing ritorno di tutte le repository di proprietà dellutente loggato, ritorno delle info inerenti alla repository specificata
* - 2021-05-01
- 3.0h
- Riunione con il team per sprint review e sprint retrospective(2h). Testing modifica ed eliminazione di una repository (nome, stato)
* - 2021-05-02
- 2.0h
- Testing del frontend tramite UI, controllo generale dei test già effettuati.
Giorgio Minoccari - Sviluppatore Backend
""""""""""""""""""""""""""""""""""""""""
Durante lo sprint ho principalmente svolto sviluppo e test riguardo alla API di twitter, in modo da poter effettuare chiamate efficenti e non venire limitati dal sito riguardo alle richieste effettuate.
.. list-table::
:header-rows: 1
* - Data
- Durata
- Attività
* - 2021-04-21
- 1.0h
- Primi test riguardo autenticazione Oauth per API twitter
* - 2021-04-23
- 1.5h
- Autenticazione funzionante
* - 2021-04-24
- 0.5h
- Test su ricerche generali con parole chiave
* - 2021-04-26
- 1.0h
- Test su ricerche geolocalizzate
* - 2021-04-27
- 1.0h
- Definizione di entita' di esempio nei database per provare funzioni legate ad esse
* - 2021-04-28
- 2.0h
- Definizione di funzioni per l'aggregazione di condizioni di diverso tipo per la ricerca di tweet tramite API
* - 2021-04-29
- 1.0h
- Refactor codice scritto fino a quel momento, eliminazione di dati inutili
* - 2021-05-01
- 1.0h
- Implementazioni di analisi su termini e hashtag restituiti dall'API
* - 2021-05-02
- 1.0h
- Test di chiamata alle funzioni di ricerca a partire da repository con condizioni complesse aggregate
Lorenzo Balugani - Developer
""""""""""""""""""""""""""""
.. list-table::
:header-rows: 1
* - Data
- Durata
- Attività
* - 2021-04-21
- 2.0h
- Implementazione Base di Dati
* - 2021-04-22
- 2.0h
- Login, creazione utenti
* - 2021-04-25
- 1.0h
- Rimozione utenti, CORS, Creazione repo
* - 2021-04-25
- 3.0h
- Altre funzioni API
* - 2021-04-26
- 0.5h
- Standardizzazione output json
* - 2021-04-26
- 1.0h
- Documentazione
* - 2021-04-27
- 0.5h
- Aggiunto supporto al modulo explorer, fix
* - 2021-04-28
- 0.5h
- Bugfixing
* - 2021-04-29
- 1.0h
- Gestione migliorata errori
* - 2021-04-29
- 1.0h
- Refactoring
* - 2021-05-02
- 1.0h
- Bugfixing
FLavia Cocca - Scrum Master
"""""""""""""""""""""""""""
.. list-table::
:header-rows: 1
* - Data
- Durata
- Attività
* - 2021-04-27
- 1.0h
- modifica mockup UI
* - 2021-04-28
- 1.0h
- Organizzazione Sprint retrospective
* - 2021-04-30
- 1.0h
- modifica mockup UI
* - 2021-05-01
- 2.0h
- Riunione con il team per sprint review e sprint retrospective
* - 2021-05-02
- 3.0h
- Stesura documenti Sprint1(debito tecnico e relazione sprint retrospective), realizzazione video Sprint1 review
Chiara Calzolari - UI Designer
""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 1
* - Data
- Durata
- Attività
* - 2021-04-26
- 3.0h
- Configurazione ambiente di sviluppo
* - 2021-04-27
- 1.0h
- modifica mockup UI (adeguamento al JS)
* - 2021-04-29
- 2.0h
- modifica mockup UI (Manage users)
* - 2021-05-01
- 0.5h
- Ultimi ritocchi al mockup UI
Stefano Pigozzi - Frontend Developer
""""""""""""""""""""""""""""""""""""
.. todo:: Compilare con i dati di Toggl!
Sprint 2
--------
Riunioni collettive
^^^^^^^^^^^^^^^^^^^
.. list-table::
:header-rows: 1
* - Data
- Ora
- Durata
- Attività
* - 2021-05-14
- 10:00
- 1.0h
- Sprint Retrospective session
Attività individuali
^^^^^^^^^^^^^^^^^^^^
Chiara Calzolari - UI Designer
""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 2
* - Data
- Durata
- Attività
* -
- 11.0h
- Totale
* - 2021-05-03
- 1.0h
- Testing frontend e segnalazione issues
* - 2021-05-03
- 1.0h
- Modifica mockup UI (Dashboard repository)
* - 2021-05-04
- 1.0h
- Modifica mockup UI (adeguamento al JS)
* - 2021-05-10
- 3.0h
- Configurazione ambiente di sviluppo
* - 2021-05-11
- 1.5h
- Modifica UI (traduzione in Italiano)
* - 2021-05-12
- 0.5h
- Modifica UI (traduzione in Italiano)
* - 2021-05-14
- 3.0h
- Realizzazione video demo sprint 2
Stefano Goldoni - Product Owner & Tester
""""""""""""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 2
* - Data
- Durata
- Attività
* -
- 16.0h
- Totale
* - 2021-05-04
- 1.0h
- preparazione backlog sprint 2
* - 2021-05-10
- 3.0h
- test sprint 2
* - 2021-05-11
- 2.5h
- test utenti e repository
* - 2021-05-12
- 2.0h
- test repository
* - 2021-05-13
- 2.5h
- test repository
* - 2021-05-14
- 3.0h
- test conditions
* - 2021-05-15
- 2.0h
- test conditions + sonarqube scanner
Lorenzo Balugani - DB & Backend Developer
"""""""""""""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 2
* - Data
- Durata
- Attività
* -
- 19.0h
- Totale
* - 2021-05-05
- 4.0h
- Setup di swagger, documentazione
* - 2021-05-06
- 4.0h
- Documentazione, sviluppo
* - 2021-05-07
- 3.0h
- Alert, documentazione
* - 2021-05-10
- 2.0h
- Alert Put, bugfixing
* - 2021-05-11
- 3.0h
- Bugfixing, sviluppo
* - 2021-05-12
- 3.0h
- Risolti issue pubblicati su Taiga
* - 2021-05-13
- 1.0h
- Bugfixing
* - 2021-05-14
- 1.0h
- Bugfixing
Stefano Pigozzi - Sysadmin & Frontend Developer
"""""""""""""""""""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 2
* - Data
- Durata
- Attività
* -
- 27.5h
- Totale
* - 2021-05-05
- 0.40h
- Riunione
* - 2021-05-05
- 0.21h
- Documentazione
* - 2021-05-06
- 0.09h
- Sviluppo
* - 2021-05-06
- 0.03h
- Configurazione Taiga
* - 2021-05-06
- 0.11h
- Documentazione
* - 2021-05-06
- 0.09h
- Riunione
* - 2021-05-06
- 0.20h
- Documentazione
* - 2021-05-06
- 0.39h
- Sviluppo
* - 2021-05-06
- 0.15h
- Riunione
* - 2021-05-06
- 1.04h
- Riunione
* - 2021-05-07
- 1.47h
- Sviluppo
* - 2021-05-07
- 0.17h
- Sviluppo
* - 2021-05-07
- 0.34h
- Sviluppo
* - 2021-05-07
- 0.34h
- Project management
* - 2021-05-07
- 2.44h
- Sviluppo
* - 2021-05-08
- 0.13h
- Sviluppo
* - 2021-05-08
- 0.29h
- Sviluppo
* - 2021-05-08
- 0.18h
- Sviluppo
* - 2021-05-10
- 1.00h
- Sviluppo
* - 2021-05-10
- 1.15h
- Configurazione GitLab
* - 2021-05-10
- 0.25h
- Sviluppo
* - 2021-05-10
- 0.39h
- Sviluppo
* - 2021-05-11
- 0.25h
- Bugfixing
* - 2021-05-11
- 3.57h
- Sviluppo
* - 2021-05-11
- 1.45h
- Sviluppo
* - 2021-05-12
- 0.10h
- Sviluppo
* - 2021-05-12
- 1.51h
- Sviluppo
* - 2021-05-13
- 1.00h
- Sviluppo
* - 2021-05-13
- 1.20h
- Sviluppo
* - 2021-05-14
- 0.20h
- Sviluppo
* - 2021-05-15
- 3.17h
- Documentazione
Flavia Cocca - Scrum Master & UI Designer
"""""""""""""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 2
* - Data
- Durata
- Attività
* -
- 16.0h
- Totale
* - 2021-05-04
- 0.5h
- Riunione per con PO, nuovo backlog
* - 2021-05-05
- 1.0h
- Riunione
* - 2021-05-07
- 3.0h
- Refactoring test
* - 2021-05-08
- 2.0h
- Refactoring test
* - 2021-05-09
- 3.0h
- Nuovi test
* - 2021-05-11
- 2.5h
- Discussione test e risoluzione di alcune issue
* - 2021-05-13
- 1.0h
- Bugfixing
* - 2021-05-14
- 1.0h
- Sprint Retrospective
* - 2021-05-15
- 2.0h
- Documentazione
Giovanni Anniballi - Tester
"""""""""""""""""""""""""""
.. list-table::
:header-rows: 2
* - Data
- Durata
- Attività
* -
- 17.0h
- Totale
* - 2021-05-04
- 0.5h
- Incontro con SM e PO per valutare quali US andranno nello sprint2
* - 2021-05-05
- 1.0h
- Incontro con il team
* - 2021-05-07
- 2.0h
- Refactoring tests sugli user e primi utilizzi delle fixtures
* - 2021-05-08
- 2.0h
- Completamento test users
* - 2021-05-10
- 1.0h
- Ulteriori approcci (fallimentari) al coverage di SonarQube
* - 2021-05-11
- 2.0h
- Discussione sui test e correzioni bug
* - 2021-05-12
- 1.0h
- Test repository
* - 2021-05-13
- 1.0h
- Generazione coverage pytest e setting sonarqube (riuscito!)
* - 2021-05-14
- 4.0h
- Sprint review e retrospettiva, conclusione test repository
* - 2021-05-15
- 2.5h
- generazione nuovo coverage e fix a sonarqube 2h, fix piccoli bug segnalati da sonarqube 0.5h
Giorgio Minoccari - Analyst & Backend Developer
"""""""""""""""""""""""""""""""""""""""""""""""
.. list-table::
:header-rows: 2
* - Data
- Durata
- Attività
* -
- 10.0h
- Totale
* - 2021-05-04
- 0.5h
- Aggiunta della condizione sull'utente
* - 2021-05-10
- 2.0h
- Tentativo di inserimento delle query con place_id
* - 2021-05-11
- 1.5h
- Test per passare alla versione 2.0 delle API
* - 2021-05-12
- 1.0h
- Ritorno alla versione 1.1 perche' lascia disponibili le query sulla geolocalizzazione gratuitamente
* - 2021-05-14
- 5.0h
- Integrazione e inserimento dei tweet catturati nel database
Sprint 3
--------
.. todo::
Compilare il registro attività dello sprint 3.

View file

@ -0,0 +1,20 @@
Statistiche di Gitinspector
===========================
Queste statistiche sono state generate dal prof. Missiroli con `Gitinspector <https://github.com/ejwa/gitinspector>`_.
.. note::
Le statistiche probabilmente sono molto inaccurate, in quanto Gitinspector sembra tenere conto anche delle directory
contenenti file vendored, come ``docs/build``.
.. todo::
Aggiungere le statistiche degli sprint mancanti!
- :download:`Sprint 0 <0-stats.html>`
- :download:`Sprint 1 <1-stats.html>`
- :download:`Sprint 2 (codice) <2-stats.html>`
- :download:`Sprint 2 (documentazione) <2D-stats.html>`
- :download:`Sprint 3 (codice) <3-stats.html>`
- :download:`Sprint 3 (documentazione) <3D-stats.html>`

View file

@ -0,0 +1,3 @@
Strumenti utilizzati
====================

View file

@ -18,6 +18,16 @@ Benvenuto alla documentazione di N.E.S.T.!
meta/index meta/index
.. toctree::
:maxdepth: 2
:caption: Compendio del progetto
development/client/index
development/stats/index
development/log
development/tools
.. toctree:: .. toctree::
:caption: Documentazione autogenerata :caption: Documentazione autogenerata

View file

@ -1,13 +1,3 @@
# Log riunioni collettive dello Sprint 0
| Data | Ora | Durata | Attività |
|------|-----|--------|----------|
| 2021-04-08 | 20:45 | 1h | Analisi documento di specifiche |
| 2021-04-09 | 14:15 | 35m | Intervista con il cliente |
| 2021-04-09 | 15:00 | 1h | Resoconto intervista |
| 2021-04-11 | 15:03 | 2h 39m | Documentazione e planning poker |
| 2021-04-15 | 18:15 | 52m | Documentazione |
| 2021-04-17 | 15:05 | 4h | Documentazione e partita a Scrumble |
# Log attività individuali dello Sprint 0 # Log attività individuali dello Sprint 0