From 5a7f3a80af043179be62b2831f12c5b70e5c0a6a Mon Sep 17 00:00:00 2001 From: Stefano Pigozzi Date: Wed, 10 Nov 2021 02:49:56 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=93=20Add=20working=20index=20and=20ab?= =?UTF-8?q?stract=20screenshot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/conf.py | 1 + docs/source/docs/1_sinossi/index.rst | 9 +- docs/source/docs/1_sinossi/screenshot.png | 3 + docs/source/docs/2_introduzione/index.rst | 4 +- docs/source/docs/2_introduzione/tech.rst | 140 +++++++++++++++++++++- 5 files changed, 150 insertions(+), 7 deletions(-) create mode 100644 docs/source/docs/1_sinossi/screenshot.png diff --git a/docs/source/conf.py b/docs/source/conf.py index 192a56d..559cc44 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -21,6 +21,7 @@ language = "it" # Sphinx extensions extensions = [ "sphinx.ext.intersphinx", + "sphinx.ext.autosectionlabel", ] # Source files encoding diff --git a/docs/source/docs/1_sinossi/index.rst b/docs/source/docs/1_sinossi/index.rst index b3757bd..13fcafb 100644 --- a/docs/source/docs/1_sinossi/index.rst +++ b/docs/source/docs/1_sinossi/index.rst @@ -1,6 +1,11 @@ -******* +.. index:: + ! single: Sophon + single: sinossi + single: abstract + Sinossi ******* -.. index:: ! Sophon, sinossi, abstract Sophon รจ una suite di software che permette a gruppi di ricerca di collaborare in sicurezza da remoto all'interno di ambienti Jupyter eseguiti sui server della loro organizzazione. + +.. image:: screenshot.png diff --git a/docs/source/docs/1_sinossi/screenshot.png b/docs/source/docs/1_sinossi/screenshot.png new file mode 100644 index 0000000..36e1bda --- /dev/null +++ b/docs/source/docs/1_sinossi/screenshot.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a684f2d0ad14db1bf77e5b0837f69d9fb25e4cfbd44aaf5df3d756b421838729 +size 95898 diff --git a/docs/source/docs/2_introduzione/index.rst b/docs/source/docs/2_introduzione/index.rst index 7190edc..21c68fd 100644 --- a/docs/source/docs/2_introduzione/index.rst +++ b/docs/source/docs/2_introduzione/index.rst @@ -2,4 +2,6 @@ Introduzione ************ -.. include:: tech.rst +.. toctree:: + + tech diff --git a/docs/source/docs/2_introduzione/tech.rst b/docs/source/docs/2_introduzione/tech.rst index 39c52f6..26518e7 100644 --- a/docs/source/docs/2_introduzione/tech.rst +++ b/docs/source/docs/2_introduzione/tech.rst @@ -1,13 +1,25 @@ -================================ +.. index:: + single: tecnologie utilizzate + single: librerie utilizzate + Tecnologie e librerie utilizzate ================================ +.. index:: + single: Docker + Docker ------ +.. index:: + single: Docker; Compose + Docker Compose -------------- +.. index:: + single: Python + Python ------ @@ -16,129 +28,249 @@ Python .. lazy-object-proxy? .. pydantic? +.. index:: + single: Poetry + Poetry ------ +.. index:: + single: Docker; SDK for Python + Docker SDK for Python (:py:mod:`docker`) ---------------------------------------- +.. index:: + single: Django + Django (:py:mod:`django`) ------------------------- +.. index:: + single: Django; REST Framework + Django REST Framework (:py:mod:`djangorestframework`) ----------------------------------------------------- .. django-filter and markdown are dependencies of this +.. index:: + single: Django; CORS Headers + Django CORS Headers (:py:mod:`django-cors-headers`) --------------------------------------------------- +.. index:: + single: Gunicorn + Gunicorn (:py:mod:`gunicorn`) ----------------------------- +.. index:: + single: PostgreSQL + PostgreSQL ---------- +.. index:: + single: Psycopg + Psycopg (:py:mod:`psycopg2`) ---------------------------- +.. index:: + single: lazy-object-proxy + :py:mod:`lazy-object-proxy` --------------------------- -Coloredlogs (:py:mod:`coloredlogs`) ------------------------------------ +.. index:: + single: coloredlogs + +:py:mod:`coloredlogs` +--------------------- + +.. index:: + single: JavaScript JavaScript ---------- +.. index:: + single: TypeScript + TypeScript ---------- .. con i tipi di @types +.. index:: + single: Node.JS + Node.JS ------- +.. index:: + single: Yarn + Yarn ---- +.. index:: + single: Bluelib + Bluelib ------- +.. index:: + single: React + React (:js:mod:`react`) ----------------------- +.. index:: + single: Create React App + Create React App (:js:mod:`create-react-app`) --------------------------------------------- .. con i react-scripts +.. index:: + single: Bluelib; React + Bluelib React (:js:mod:`@steffo/bluelib-react`) ---------------------------------------- +----------------------------------------------- + +.. index:: + single: Reach Router Reach Router (:js:mod:`@reach/router`) -------------------------------------- +.. index:: + single: Font Awesome + Font Awesome (:js:mod:`@fortawesome/fontawesome-svg-core`) ------------------------------------------------------------------------------------------------------------------------------------------------------ .. con le sue dipendenze @fortawesome/free-regular-svg-icons e @fortawesome/free-solid-svg-icons +.. index:: + single: Font Awesome; for React + Font Awesome for React (:js:mod:`@fortawesome/react-fontawesome`) ----------------------------------------------------------------- +.. index:: + single: Jest + Jest (:js:mod:`jest`) --------------------- .. con tutte le sue sottodipendenze @testing-library +.. index:: + single: Axios + Axios (:js:mod:`axios`) ----------------------- +.. index:: + single: Markdown + Markdown -------- +.. index:: + pair: React; Markdown + React Markdown (:js:mod:`react-markdown`) ----------------------------------------- +.. index:: + single: React; Storage Hooks + :js:mod:`react-storage-hooks` ----------------------------- +.. index:: + single: Serve + :js:mod:`serve` --------------- +.. index:: + single: Apache HTTP Server + single: httpd + Apache HTTP Server (httpd) -------------------------- +.. index:: + single: Jupyter + Jupyter ------- +.. index:: + single: Jupyter; Lab + JupyterLab ---------- +.. index:: + single: Jupyter; Notebook + Jupyter Notebook ---------------- +.. index:: + single: IPython + single: Jupyter; IPython + IPython ------- +.. index:: + single: Git + Git --- +.. index:: + single: GitHub + GitHub ------ +.. index:: + single: GitHub; Actions + GitHub Actions -------------- +.. index:: + single: GitHub; Containers + GitHub Containers ----------------- +.. index:: + single: IntelliJ IDEA + single: IDEA + IntelliJ IDEA ------------- +.. index:: + single: Sphinx + Sphinx (:py:mod:`sphinx`) ------------------------- +.. index:: + single: Sphinx; RTD Theme + :py:mod:`sphinx_rtd_theme` --------------------------