diff --git a/docs/build/doctrees/crawler/index.doctree b/docs/build/doctrees/crawler/index.doctree index b1deb9b..958882b 100644 Binary files a/docs/build/doctrees/crawler/index.doctree and b/docs/build/doctrees/crawler/index.doctree differ diff --git a/docs/build/doctrees/development/tools.doctree b/docs/build/doctrees/development/tools.doctree new file mode 100644 index 0000000..949be9f Binary files /dev/null and b/docs/build/doctrees/development/tools.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index f6e523f..bb54186 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index ebf4b4d..586c151 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/meta/index.doctree b/docs/build/doctrees/meta/index.doctree new file mode 100644 index 0000000..5a889fe Binary files /dev/null and b/docs/build/doctrees/meta/index.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index 062c135..95ae78d 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # 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. -config: 697fdcf2a865ef95bc825235d33ec5a4 +config: 1567c588e515e4bb5e7b4b124607e7dc tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_images/docsRunConfig.png b/docs/build/html/_images/docsRunConfig.png new file mode 100644 index 0000000..9380620 Binary files /dev/null and b/docs/build/html/_images/docsRunConfig.png differ diff --git a/docs/build/html/_sources/crawler/index.rst.txt b/docs/build/html/_sources/crawler/index.rst.txt index 422f74e..ca1451e 100644 --- a/docs/build/html/_sources/crawler/index.rst.txt +++ b/docs/build/html/_sources/crawler/index.rst.txt @@ -1,2 +1,4 @@ ``nest_crawler`` - Crawler in Python ==================================== + +.. automodule:: nest_crawler diff --git a/docs/build/html/_sources/development/tools.rst.txt b/docs/build/html/_sources/development/tools.rst.txt new file mode 100644 index 0000000..50217d4 --- /dev/null +++ b/docs/build/html/_sources/development/tools.rst.txt @@ -0,0 +1,3 @@ +Strumenti utilizzati +==================== + diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index 02ac08b..aa3257a 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -18,6 +18,16 @@ Benvenuto alla documentazione di N.E.S.T.! meta/index +.. toctree:: + :maxdepth: 2 + :caption: Compendio del progetto + + development/client/index + development/stats/index + development/log + development/tools + + .. toctree:: :caption: Documentazione autogenerata diff --git a/docs/build/html/_sources/meta/index.rst.txt b/docs/build/html/_sources/meta/index.rst.txt new file mode 100644 index 0000000..386acee --- /dev/null +++ b/docs/build/html/_sources/meta/index.rst.txt @@ -0,0 +1,84 @@ +Meta-documentazione +=================== + +La documentazione è scritta in `reStructuredText `_, ed è generata con +`Sphinx `_. + +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 `_, qualora il progetto fosse ospitato su GitHub o disponessimo di una licenza +almeno `Basic `_. + + +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 diff --git a/docs/build/html/about/index.html b/docs/build/html/about/index.html index 817f480..a605dc6 100644 --- a/docs/build/html/about/index.html +++ b/docs/build/html/about/index.html @@ -50,7 +50,7 @@