.. _h4a6529483549719b66336a3470283f: Il lavoro da fare su Github *************************** |REPLACE1| | .. _h27d37777d6f59f417f254b4fa3a: 1. Creare il nome del progetto ============================== Creare il nome del progetto. Scrivere nel file ``READ.ME`` la descrizione di cosa contiene quel progetto (un po di metadatazione del progetto). Come nel caso del \ |LINK1|\ . Il nome del progetto sarà richiamato dal plugin GGeditor una volta richiamato l’account Github ed editati user e password. Appariranno su un pannello i vari repository Github del nostro account e si sceglierà quello a cui inviare i Google Doc ai quali lavoreremo. | .. _h777c557c582d38262c7972186a6c3026: 2. Creare un file “conf.py” =========================== Creare un file dandogli il nome ``conf.py`` e all’interno incollare il seguente codice .. code-block:: python :linenos: # -*- coding: utf-8 -*- from __future__ import unicode_literals import sys, os import re from sphinx_rtd_theme import __version__ as theme_version from sphinx_rtd_theme import __version_full__ as theme_version_full on_rtd = os.environ.get('READTHEDOCS', None) == 'True' sys.path.append(os.path.abspath(os.pardir)) __version__ = '1.0' # -- General configuration ----------------------------------------------------- source_suffix = '.rst' master_doc = 'index' project = 'CHANGE-THIS' copyright = '2016, CHANGE-THIS' # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' extlinks = {} # -- Options for HTML output --------------------------------------------------- html_theme = 'sphinx_rtd_theme' html_static_path = ['static'] def setup(app): # overrides for wide tables in RTD theme app.add_stylesheet('theme_overrides.css') # path relative to static """ You might want to uncomment the “latex_documents = []” if you use CKJ characters in your document. Because the pdflatex raises exception when generate Latex documents with CKJ characters. """ #latex_documents = [] # inserire un logo in alto a sinistra (mettendo l’immagine nella cartella “static”) latex_logo = "static/immagine.jpg" html_logo = "static/immagine.jpg" .. Important:: Nella pagine del codice sostituire i seguenti parametri: .. code:: project = 'CHANGE-THIS' al posto di CHANGE-THIS (dentro gli apici) editare il nome del titolo progetto che si vuole far comparire su Read the Docs; .. code:: copyright = '2016, CHANGE-THIS' al posto di CHANGE-THIS (dentro gli apici) editare il tipo di licenza che si intende adottare per il rilascio della pubblicazione su Read the Docs. \ |STYLE0|\ Se si vuole far visualizzare un logo sulla parte in alto a sinistra, si procede in questo modo: alla fine del codice del file ``conf.py``, bisogna scrivere: .. code:: latex_logo = "static/immagine.jpg" html_logo = "static/immagine.jpg" dove ``immagine.jpg`` sarà l’immagine da visualizzare in alto a sinistra (logo del nostro progetto), che metteremo dentro la cartella ``static``. | .. _h657a453c413f207c58413846774e759: 3. Creare il file “theme_overrides.css” e inserirlo dentro la cartella “static” =============================================================================== Il file ``theme_overrides.css`` serve per modificare la grafica base del file ``conf.py``. Serve anche per ottimizzare la visualizzazione delle tabelle ampie sulle pagine HTML di Read the Docs. Si crea questo file dentro la directory ``static``. Basta copiare il codice qui di seguito descritto in un file che chiameremo, appunto, ``theme_overrides.css`` dentro la cartella ``static``. .. code-block:: python :linenos: .wy-table-responsive table td, .wy-table-responsive table th { white-space: inherit; } .wy-table-responsive table th { background-color: #f0f0f0; } .line-block, .docutils.footnote { line-height: 24px; } .admonition { margin-bottom: 20px; line-height:24px; } .admonition > *:not(:first-child){ /* draw a boder around a admonition */ border-left: solid 1px #b59e9e; border-right: solid 1px #b59e9e; padding: 12px; margin: -12px -12px -12px -12px; margin-bottom: -12px !important; } .admonition > .last, .admonition- > .last{ /* draw a boder around a admonition */ border-bottom: solid 1px #b59e9e !important; } /* adatta il nav-content a fullhd e si elimina lo spazio vuoto piccolo a destra */ .wy-nav-content {max-width: 1920px;} (guarda \ |LINK2|\ ). L’istruzione ``.wy-nav-content {max-width: 1920px;}`` consente di estendere per tutta la larghezza del monitor lo spazio in cui viene visualizzato il testo, dando una sensazione grafica gradevole all’intero documento. | .. _h4f646e4b7638264b7332423622b1e4f: Come fare leggere un file in formato ``.MD`` a ReadtheDocs (in un progetto su Github) ===================================================================================== (\ |LINK3|\ ) Se voglio far leggere un file ``.MD`` a Read the Docs, oltre ai file ``.RST``, quali impostazioni devo settare e dove li devo settare su Github? Bisogna guardare questi due file ``requirements.txt`` e ``conf.py`` sul progetto ospitato da Github. ``requirements.txt`` ``requirements.txt`` è il file che contiene i requisiti dei moduli da installare. Vedi ad esempio: https://github.com/opendatasicilia/tansignari/blob/master/requirements.txt. Bisogna inserire queste istruzioni di seguito elencate nel file: .. code:: sphinx-rtd-theme sphinx recommonmark markdown sphinx-markdown-tables – ``conf.py`` ``conf.py`` è il file di configurazione in linguaggio Python. In queste linee si imposta la configurazione che abilita il Markdown (.MD) su Read the Docs. .. code:: import recommonmark from recommonmark.transform import AutoStructify from recommonmark.parser import CommonMarkParser source_parsers = { '.md': 'recommonmark.parser.CommonMarkParser', } source_suffix = ['.rst', '.md'] extensions = ['sphinx.ext.ifconfig','sphinx_markdown_tables'] Bisogna inserire queste righe di codice nel file ``conf.py``. | .. _h1485f695e393f6b591579642211623: Una configurazione leggera ed efficace ======================================= Con le tre azioni di sopra si conclude tutto il lavoro da svolgere su Github, quindi questa soluzione si presta a chi non ha dimestichezza con il linguaggio ``RST``. Una configurazione del progetto Github molto leggera ma efficace in termini di risultati di pubblicazione di un documento sul design Read the Docs. \ |IMG1|\ Come si nota dall’elenco dei file che vengono generati dal plugin ``GGeditor`` direttamente nel repository Github abbiamo: * un file ``README.md`` che è un file di descrizione del progetto, che provvediamo a editare noi su Github per far capire al lettore che cosa contiene il repository Github in questione. Questo file lo creiamo noi; * il file ``conf.py`` che contiene il codice con indicazioni necessarie all’esposizione dei Google Docs sulla piattaforma di Read the Docs. \ |LINK4|\ . Basta creare un file nel repository Github, dargli il nome di ``conf.py`` e fare un copia e incolla dal paragrafo del tutorial di GGeditor. Questo file lo creiamo noi; * una directory ``static`` che contiene soltanto immagini ``.png`` che sono le immagini che incolliamo nel Google Doc e che nell’azione del “\ |STYLE1|\ ”, avviata dal plugin GGeditor, vengono generate automaticamente e inviate nella cartella ``static``. Questa cartella ``static`` viene generata automaticamente dal plugin GGeditor; * il file ``theme_overrides.css`` che creeremo dentro la directory ``static``. * i file ``.rst`` che sono i Google Doc convertiti automaticamente in file ``.rst`` dal plugin GGeditor e inviati nel repository Github. Questi file vengono generati dal componente aggiuntivo di Google doc, GGeditor; Dalla descrizione di questi file si comprende come l’intero pacchetto su Github è molto semplice come tipologia di file. L’unico più complesso da capire è il contenuto del file ``conf.py`` e del file ``theme_overrides.css`` ma sono file che non dobbiamo nemmeno creare, perchè copiamo i contenuti dei file dal tutorial, andando a cambiare al suo interno solo il “nome” del documento da pubblicare e “il tipo di licenza” (questo solo nel file ``conf.py``) e aggiungendo il nome del file immagine qualora volessimo creare un logo del progetto da far visualizzare in alto a sinistra sul progetto di Read the Docs. | .. _h15816766a462d462c4a264e604e1360: Inserire un logo in alto a sinistra nel design Read the Docs ============================================================= Per inserire un immagine in alto a sinistra nel design di “Read the Docs”, per creare il logo del nostro progetto, basta andare nel file ``conf.py`` e alla fine inserire questo codice: .. code:: latex_logo = "static/immagine.png" html_logo = "static/immagine.png" avendo cura di caricare il file ``immagine.png`` nella cartella ``static``. .. Attention:: Queste istruzioni non possono essere dati ai documenti da pubblicare in stile \ |STYLE2|\ , ma solo ai documenti da pubblicare nello stile di base Read the Docs. | .. _h7811280507b551e41e535622522b68: Inserire la freccia “back to the top” nella pagina HTML ======================================================= \ |IMG2|\ Al fine di permettere di risalire rapidamente in alto nella pagina HTML, torna comoda l’icona a forma di freccia sulla parte destra in basso della stessa pagina. Di seguito la procedura per ottenere la freccia “back to the top” sulla pagina HTML. Creare la cartella ``_templates`` e all’interno di essa creare il file ``layout.html`` e copiare il seguente codice: .. code-block:: python :linenos: {% endblock %} {% block footer %} {{ super() }}
Back To Top
{% endblock %} Nella cartella ``static`` creare i file: * \ |LINK5|\ * \ |LINK6|\ * \ |LINK7|\ * \ |LINK8|\ copiando il codice dai rispettivi file dei link di sopra. Sempre dento la cartella ``static``, bisogna inserire un'immagine (con la freccia in alto) come questa contenuta \ |LINK9|\ . E infine non dimenticare di inserire nel file ``conf.py`` alla fine delle righe, il seguente codice: .. code:: templates_path = ['_templates'] | .. _h7a6c7f326e4f7cd203675a6783f19: Inserire lateralmente icone per la condivisione delle pagine HTML di Read the Docs sui social network ===================================================================================================== Al fine di permettere la condivisione delle pagine del documento Read the Docs sui social network, una delle soluzioni che graficamente si adatta meglio alla grafica delle pagine RTD è fornita dalla piattaforma gratuita \ |LINK10|\ . Una volta creato l’account su \ |STYLE3|\ è possibile creare icone personalizzate (colore, dimensione) per la visualizzazione delle stesse sulle pagine html di RTD. Una volta creato il banner, sempre nella piattaforma addthis andare su “get the code” e copiare il codice che viene fornito. Tale codice è di questo tipo .. code:: e va incollato nella pagina ``layout.html`` (dentro la cartella ``_templates``) prima di ``{% endblock %}``. Tutto qui. | .. _h2305e72776d31f1e2261484a6a7828: Aggiungere un'immagine dinamica in stile Word Cloud (WordArt) ============================================================= Con \ |LINK11|\ è possibile creare immagini composte da parole che al passaggio del mouse vengono evidenziate. Cosa fare per incorporare queste word cloud dentro una pagina HTML del progetto Read the Docs? #. Attivare un account su \ |LINK12|\ e cominciare a creare un progetto. Si può importare l’elenco delle parole anche da una pagina web tramite l’URL. #. Nel file ``layout.html`` del progetto Github inserire lo script: ````. #. Nella pagina di Google doc di interesse inserite il codice che \ |LINK13|\ vi dà dopo la creazione del vostro progetto. In ordine: Salvate il vostro progetto (save) - Andate su “share” quindi cliccate su “Embed on a webpage”. #. Copiate il codice, che dovrebbe essere di questo tipo ``
``, sulla pagina Google doc tramite la funzione HTML del pannello Markup di GGeditor. Quindi fate il solito commit su GGeditor che trasmetterà la nuova funzione a Github e così automaticamente vedrete sulle pagine HTML di Read the Docs la vosytra nuova Word Cloud Ecco la Word Cloud |REPLACE2| | .. _h131147592710157a6a6e625a7d526312: Inserire in fondo alla pagina HTML del progetto Read the Docs lo spazio Disqus per i commenti ============================================================================================= È possibile inserire in fondo alla pagina HTML del progetto Read the Docs uno spazio destinato ai commenti degli utenti, come avviene per tantissimi blog. Uno dei servizi online gratuiti e molto diffusi è \ |LINK14|\ . È necessario creare un account su questo servizio e creare un progetto con lo stesso nome del progetto Read the Docs. Per ogni progetto creato su Disqus verrà fornito il seguente codice da inserire nella pagina ``footer.html``: .. code::

dove la parte ``guida-readthedocs`` deve essere sostituita con il nome del progetto specifico individuato su \ |STYLE4|\ per il documento da pubblicare con lo stile “Read the Docs”. Il codice sopra illustrato deve essere inserito nella pagina ``footer.html`` prima delle seguenti righe di codice: .. code:: {%- block extrafooter %} {% endblock %} Guarda direttamente al file \ |LINK15|\ su GitHub per comprendere meglio. | .. _h1d174020704f7c333b244d404e247c: Inserire il popup eu-cookie nei progetti "read the docs" ========================================================= (\ |STYLE5|\ ) Per aggiungere il popup \ |STYLE6|\ per dare visibilità dei contenuti concernenti la privacy, basta aggiungere i tre file script di seguito elencati nella cartella ``static`` del progetto Github: * \ |LINK16|\ * \ |LINK17|\ * \ |LINK18|\ Inserire nel file \ |LINK19|\ (nel blocco principale) il codice html: .. code:: Sempre nel file ``layout.html`` inserire il seguente codice: .. code::
Guarda il \ |LINK20|\ per il corretto inserimento del codice. Per modificare il testo del popup, apri il file ``jquery-eu-cookie-law-popup.js`` con notepad++, o anche con il semplice notepad, e cerca il blocco \ |STYLE7|\ , e li modifichi ``url`` della pagina \ |STYLE8|\ ed il testo: .. code:: // PARAMETERS (MODIFY THIS PART) /////////////////////// _self.params = { cookiePolicyUrl : 'https://cirospat.readthedocs.io/it/latest/privacy.html', popupPosition : 'top', colorStyle : 'default', compactStyle : false, popupTitle : 'Questo sito web utilizza i cookie, anche di terze parti, per migliorare la vostra esperienza di navigazione web.', popupText : 'Chiudendo questo banner, scorrendo questa pagina o cliccando su qualunque suo elemento acconsenti all’uso dei cookie. Per maggiori informazioni o per negare il consenso a tutti o ad alcuni cookie, consulta l’informativa.', buttonContinueTitle : 'Chiudi! ', buttonLearnmoreTitle : 'Leggi l’informativa', buttonLearnmoreOpenInNewWindow : false, agreementExpiresInDays : 30, autoAcceptCookiePolicy : false, htmlMarkup : null }; \ |STYLE9|\ che devi aggiungere nel tuo progetto “Read the Docs” la pagina dell'\ |LINK21|\ . Ovviamente questa pagina HTML sarà del testo preventivamente editato su un Google doc. | .. _h775782304944104a63b1778f5f7e: Cambiare il colore di sfondo del rettangolo in alto a sinistra ============================================================== Cambiare colore sul rettangolo superiore in alto a sinistra, dove è situato il nome del progetto, è possibile. Qui di seguito si riporta il codice da inserire sul file ``theme_overrides.css`` che si trova dentro la cartella ``static``: .. code:: } .wy-side-nav-search { background-color: #525e99; } il codice “#525e99“ usato in questo caso (il colore del rettangolo in alto a sinistra del tutorial che state leggendo) corrisponde alla tonalità cromatica verificabile a questo link:\ |LINK22|\ . Ovviamente cambiando codice numerico (con #iniziale) è possibile generare altre tonalità da applicare al caso specifico. .. Attention:: Queste istruzioni non possono essere dati ai documenti da pubblicare in stile \ |STYLE10|\ , ma solo ai documenti da pubblicare nello stile di base Read the Docs. | .. _h42f507fa1c6a29605c5a1a3a442f: Cambiare il colore dei titoli dei capitoli, paragrafi, sottoparagrafi, ecc. =========================================================================== Come prima, è anche possibile cambiare il colore dei titoli dei capitoli, paragrafi, sottoparagrafi, ecc. Sempre sul file ``theme_overrides.css`` si riporta il seguente codice: .. code:: } h1, h2, h3 { color: #176a90 !important; } il codice “\ |LINK23|\ ” può essere cambiato con i codici di tantissimi altri colori disponibili. .. Attention:: Queste istruzioni non possono essere dati ai documenti da pubblicare in stile \ |STYLE11|\ , ma solo ai documenti da pubblicare nello stile di base Read the Docs. | .. _h435c1952197778195394ea405b2f43: Inserire una barra di scroll orizzontale in alto nella pagina ============================================================= Al fine di far visualizzare al visitatore della pagina a che livello (sull’intera pagina) è arrivato nella lettura, torna utile inserire un piccolo sottile scroll orizzontale da posizionare in alto. Bisogna fare due cose. Prima cosa: incollare nel file ``layout.html`` il seguente codice, prima della riga in cui si trova ``{% endblock %}``: .. code:: dove * ‘\ |STYLE12|\ ’ è l’altezza della barra dell scroll * ‘\ |STYLE13|\ ’ è il codice del colore che vogliamo assegnare alla barra dello scroll. A questo \ |LINK24|\ è possibile scegliere i codici di una vasta gamma di colori da utilizzare. Seconda cosa da fare: creare un file Java Script ``prognroll.js`` nella cartella ``static`` dove inserire \ |LINK25|\ . | .. _h206b132a6447317f607c2b3751106c78: Uno schema tipo di progetto Github che raccoglie tutte le funzioni illustrate in questa pagina del tutorial =========================================================================================================== |REPLACE3| A questa pagina di Github \ |LINK26|\ si trova uno “\ |STYLE14|\ ” di repository la cui restituzione come progetto Read the Docs è disponibile qui: \ |LINK27|\ . Lo schema tipo Github può essere clonato per creare un altro progetto Github che abbia le stesse impostazioni, che graficamente sono visibili nel relativo \ |LINK28|\ . Quindi la funzione dello schema tipo Github è quella di facilitare tutte le procedure di editing del codice, non dovendo pensare a crearlo da zero, e dando la possibilità all’utente di cambiare le personalizzazioni (titolo del progetto e versione della licenza nel file ``conf.py``, colore testo dei capitoli/paragrafi, colore del riquadro in alto a sinistra e altre impostazioni nel file ``theme_override.css`` dentro la cartella ``static``) e di concentrarsi maggiormente sui contenuti (testo, immagini, video,..) della pubblicazione che saranno editati direttamente dentro i Google doc. | |REPLACE4| .. bottom of content .. |STYLE0| replace:: **Creare il logo in alto a sinistra** .. |STYLE1| replace:: **Commit** .. |STYLE2| replace:: **Docs Italia** .. |STYLE3| replace:: **addthis** .. |STYLE4| replace:: **Disqus** .. |STYLE5| replace:: **istruzioni a cura di Giovan Battista Vitrano** .. |STYLE6| replace:: **eu-cookie** .. |STYLE7| replace:: **PARAMETERS (MODIFY THIS PART)** .. |STYLE8| replace:: **privacy** .. |STYLE9| replace:: **Ricordati (!)** .. |STYLE10| replace:: **Docs Italia** .. |STYLE11| replace:: **Docs Italia** .. |STYLE12| replace:: **height** .. |STYLE13| replace:: **color** .. |STYLE14| replace:: **schema tipo** .. |REPLACE1| raw:: html Con il metodo proposto in questo tutorial, il lavoro che c’è da fare sull’account di      è il seguente. .. |REPLACE2| raw:: html
.. |REPLACE3| raw:: html

Asino siciliano

.. |REPLACE4| raw:: html
.. |LINK1| raw:: html file READ.ME di questo tutorial .. |LINK2| raw:: html qui .. |LINK3| raw:: html ricetta su Tansignari .. |LINK4| raw:: html Il codice del file “conf.py” viene fornito nel tutorial di GGeditor .. |LINK5| raw:: html jquerysctipttop.css .. |LINK6| raw:: html backTop.css .. |LINK7| raw:: html jquery.min.js .. |LINK8| raw:: html jquery.backTop.min.js .. |LINK9| raw:: html qui dentro .. |LINK10| raw:: html https://www.addthis.com .. |LINK11| raw:: html https://wordart.com .. |LINK12| raw:: html https://wordart.com .. |LINK13| raw:: html https://wordart.com .. |LINK14| raw:: html Disqus .. |LINK15| raw:: html footer.html .. |LINK16| raw:: html jquery-2.1.3.min.js .. |LINK17| raw:: html jquery-eu-cookie-law-popup.js .. |LINK18| raw:: html jquery-eu-cookie-law-popup.css .. |LINK19| raw:: html layout.html .. |LINK20| raw:: html file su GitHub .. |LINK21| raw:: html informativa privacy .. |LINK22| raw:: html https://www.color-hex.com/color/525e99 .. |LINK23| raw:: html #176a90 .. |LINK24| raw:: html link .. |LINK25| raw:: html questo codice .. |LINK26| raw:: html https://github.com/cirospat/rtd-schematipo .. |LINK27| raw:: html https://schema-tipo.readthedocs.io .. |LINK28| raw:: html progetto Read the Docs .. |IMG1| image:: static/lavoro-github_1.png :height: 322 px :width: 601 px .. |IMG2| image:: static/lavoro-github_2.png :height: 49 px :width: 49 px