Introduzione


Il pacchetto DOCU fornisce uno strumento per creare una documentazione tecnica, sotto forma di raccolta di argomenti gerarchici. Il pacchetto è stato concepito principalmente per documentare Genropy e/o i pacchetti con esso realizzati, pertanto alcune funzionalità risulteranno più utili o significative in quello specifico contesto.

Le features principali di Genropy DOCU sono:

  • Struttura gerarchica ed omogenea degli argomenti. Ciascun nodo dell’albero gerarchico è completo di tutte le funzionalità.
  • Testo Multilingua nativo
  • Utilizzo di RST come linguaggio di Markup
  • Caricamento di immagini e video da includere facilmente all’interno del testo
  • Caricamento di allegati (pdf, zip, py, html, ecc) scaricabili da includere in una specifica sezione a pié di pagina.
  • Visualizzazione come albero navigabile le cui pagine siano linkabili da qualunque sito esterno a Genropy
  • Aggiornamento automatico dei link in caso di modifica della struttura gerarchica
  • Raccolta dei «parametri» in una specifica tabella con particolare formattazione.

Genropy DOCU è quindi particolarmente utile per redigere manuali d’uso da consegnare ai clienti/utenti del proprio applicativo.

Includere il package DOCU nel progetto

Il package DOCU è incluso nel «core» di Genropy, e può quindi essere facilmente incluso in tutti i progetti semplicemente modificando il file instanceconfig.xml come segue:

<packages>
        <gnrcore_docu pkgcode="gnrcore:docu"/>
    <gnrcore_orgn pkgcode="gnrcore:orgn"/>
</packages>

Suggerimento

Per un corretto funzionamento del package si segnala che è obbligatorio aver preventivamente attivato anche il pkg ORGN come indicato nello snippet di codice precedente.

Prerequisiti

Per un corretto utilizzo del package Docu è necessario aver installato Sphinx:

pip install -U sphinx

Impostazioni iniziali

Una volta incluso il package nel progetto e avviata una gnrdbsetup dell’istanza è possibile procedere con l’avvio. 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

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

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

Autore della sezione: Davide Paci