1
Fork 0
mirror of https://github.com/Steffo99/sophon.git synced 2024-12-23 15:24:21 +00:00
sophon/docs/source/3_dev/2_structure/1_backend/index.rst

26 lines
834 B
ReStructuredText
Raw Normal View History

2021-11-04 02:12:27 +00:00
Modulo backend
==============
.. default-domain:: py
.. default-role:: obj
.. py:currentmodule:: sophon
2021-11-04 21:34:13 +00:00
Il *modulo backend* consiste in un server web che espone un'API e un sito web per l'amministrazione.
2021-11-04 02:12:27 +00:00
2021-11-04 03:08:07 +00:00
È collocato all'interno del repository in ``/backend``.
2021-11-04 21:34:13 +00:00
È formato dal package Python `sophon`, che contiene al suo interno un progetto Django, che a sua volta contiene le tre app Django `sophon.core`, `sophon.projects` e `sophon.notebooks`.
2021-11-04 02:12:27 +00:00
.. note::
A causa della dipendenza di Django da variabili globali, è stato impossibile utilizzare lo strumento di documentazione automatica `sphinx.ext.autodoc`.
Pertanto, si è deciso di documentare soltanto le classi e metodi più rilevanti ai fini di questa documentazione.
2021-11-04 21:34:13 +00:00
.. toctree::
:maxdepth: 1
2021-11-04 02:12:27 +00:00
2021-11-04 21:34:13 +00:00
1_techstack
2_sophon
3_core
4_projects
5_notebooks