Configurazione

Prerequisiti

Per un corretto utilizzo del package Docu è necessario aver installato Sphinx, il tema standard e l’estensione sitemap:

pip install -U sphinx
pip install sphinx-rtd-theme
pip install sphinx-sitemap

Impostazioni iniziali

Una volta incluso il package nel progetto e avviata una gnrdbsetup dell’istanza è possibile procedere con l’avvio.

Innanzitutto è necessario aver assegnato all’utente che si sta utilizzando (e a tutti gli utenti «documentatori») il Tag di Autorizzazione Documentation:

../_images/tag-autorizzazione-documentation.png

Suggerimento

Se si sta utilizzando l’utente admin di default di Genropy, è necessario modificare i tag di questo utente all’interno del file instanceconfig.xml globale:

<xml_auth defaultTags="user,xml">
    <admin pwd="***" tags="superadmin,_DEV_,admin,user,_DOC_"/>
</xml_auth>

Una volta entrati vedremo che si è automaticamente aggiunta la voce di menu Documentazione. Entriamo nella pagina Docu tables e inseriamo almeno una lingua per la nostra Documentazione:

../_images/docu-set-languages.png

Suggerimento

Sei in Sandbox e non vedi la voce Documentazione nel menù? Probabilmente stai usando il menu di default dell’applicativo! Prova a cancellare o modificare manualmente il file menu.py che si trova nella tua cartella config della tua istanza.

Inoltre dalle Preferenze generali dell’applicativo è possibile impostare un path (a piacere), una baseurl dove andremo a pubblicare i documenti, e, se abbiamo installato anche il package GENROBOT , se abilitare o meno l’invio delle notifiche agli utenti:

../_images/docu-preferenze-contelegram.png

Autore della sezione: Davide Paci