Capitolo 2 - Ora è il momento di lavorare su Read the Docs¶
Questa rappresenta la fase 2 ed è molto semplice come operazioni da effettuare. Una volta completato il lavoro di compilazione su Github, bisogna andare su http://readthedocs.io e (dopo aver creato il relativo account) importare il progetto, già creato, da Github
Nella finestra, su URL
del Deposito Codice bisogna scrivere l’URL del progetto che avete creato su Github, e quindi scegliere il nome del progetto, esempio:
Tipo del Deposito Codice
selezionato su Git
.A quel punto verrà messo in collegamento il vostro progetto di Github con la piattaforma di Red the Docs.
Una primissima cosa da fare è andare su Amministrazione
e settare la lingua italiana.
Questo consentirà a Read the Docs di aggiungere al titolo del vostro progetto la desinenza /it/latest
. Il documento è in italiano quindi prende la desinenza /it
.
Esempio: http://come-creare-guida.readthedocs.io/it/latest
A questo punto il progetto di Github è compilato su Read the Docs.
URL
compilato da Read the Docs per vedere il nostro progetto sarà:linee-guida-open-data-comune-vattelapesca.readthedocs.io
AVVISO DI «PASSING»
Procedura andata a buon fine: «passing»
Se non ci sono errori commessi durante le procedure spiegate fino ad ora, tutto andrà a buon fine, e Read the Docs darà il messaggio in colore verde di «passing» al nostro progetto, significa che il nostro progetto è - quindi - online.
AVVISO DI «FAILING»
Procedura con Errore: «failing»
Diversamente Read the Docs alla sezione i miei progetti, darà un messaggio in colore rosso di «failed». In questo caso c’è qualche problema e bisogna ripercorrere tutti i passaggi fatti da quando si è iniziato a lavorare sul sito di Read the Docs.
Abbiamo completato tutte le procedure e ci possiamo godere il nostro documento nella nuova modalità di pubblicazione e visualizzazione su Read the Docs :-)