Titolo del Read the Docs¶

cultura della documentazione

Questo progetto è solo una dimostrazione dell’esposizione di contenuti su Read the Docs.

Questa è solo una bozza

Il repository dello schema tipo RTD si trova a questo link, da potere clonare per progetti di documentazione online.

Questo Read the Docs è uno schema tipo ottimizzato (per design e setting vari) per la pubblicazione di documenti. Settaggi quali colore della colonna sinistra e colori del testo dei paragrafi, titoli, ecc., possono essere cambiati nel file theme_override.css.

Altre impostazioni di visualizzazione grafica del documento su Read the Docs possono essere effettuate sui seguenti file, all’interno della cartella _templates:

breadcrumbs.html
footer.html
layout.html
searchbox.html
versions.html

Importante

Le impostazioni dentro il repository Github di questo progetto permettono di usare sia file in formato .rST (reStructuredText), che in formato .MD (Markdown). Le istruzioni da inserire nel file conf.py sono dettagliate in questa ricetta di Tansignari.

1 - Questa è solo una bozza. Direttive su `RST`¶

Questa è solo una bozza

Il repository dello schema tipo RTD si trova a questo link, da potere clonare per progetti di documentazione online.

Questo Read the Docs è uno schema tipo ottimizzato (per design e setting vari) per la pubblicazione di documenti. Settaggi quali colore della colonna sinistra e colori del testo dei paragrafi, titoli, ecc., possono essere cambiati nel file theme_override.css.

Altre impostazioni di visualizzazione grafica del documento su Read the Docs possono essere effettuate sui seguenti file, all’interno della cartella _templates.

—

Pericolo

Beware killer rabbits!

Nota

This is a note admonition. This is the second line of the first paragraph.

And, by the way…

You can make up your own admonition too.

Topic Title

Subsequent indented lines comprise the body of the topic, and are interpreted as body elements.

Lend us a couple of bob till Thursday.

I’m absolutely skint.

But I’m expecting a postal order and I can pay you back

as soon as it comes.

Love, Ewan.

( (title_, subtitle_?)?,
  decoration_?,
  (docinfo_, transition_?)?,
  `%structure.model;`_ )

def my_function():
    "just a test"
    print 8/2

\[qui c'è la funzione matematica = (i) = P(O_1, O_2, … O_t, q_t = S_i λ)\]

No matter where you go, there you are.

—Buckaroo Banzai

This paragraph might be rendered in a custom way.

Truth table for «not»¶
A	not A
False	True
True	False

Frozen Delights!¶
Treat	Quantity	Description
Albatross	2.99	On a stick!
Crunchy Frog	1.49	If we took the bones out, it wouldn’t be crunchy, now would it?
Gannet Ripple	1.99	On a stick!

Frozen Delights!¶
Treat	Quantity	Description
Albatross	2.99	On a stick!
Crunchy Frog	1.49	If we took the bones out, it wouldn’t be crunchy, now would it?
Gannet Ripple	1.99	On a stick!

Here’s a very long Table of Contents title

1 - Questa è solo una bozza. Direttive su RST

Back in the main document.

class importante¶

This is a «special» paragraph.

class multiple¶

First paragraph. First paragraph. First paragraph. First paragraph. First paragraph. First paragraph. First paragraph. First paragraph. First paragraph. First paragraph.First paragraph.First paragraph. First paragraph. First paragraph. First paragraph.First paragraph. First paragraph. First paragraph.First paragraph. First paragraph.First paragraph.First paragraph. First paragraph. First paragraph. First paragraph.

Second paragraph.

Nota

the class values set in this directive-block do not apply to the note but the next paragraph.

class special¶

This is a paragraph with class value «special».

2 - Un po di sintassi RST¶

a questo link la sintassi RST https://raw.githubusercontent.com/cirospat/rtd-schematipo/master/2.rst

==================================================================
I titoli principali sono scritti utilizzando caratteri di uguale, sopra e sotto
==================================================================

Si noti che devono esserci tanti caratteri di uguale quanti caratteri del titolo.

Anche i titoli normali usano caratteri di uguale, ma solo sotto
===============================================================

I sottotitoli usano i trattini
------------------------------

E i sotto-sottotitoli le tildi
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Puoi inserire il testo in *corsivo* o in **grassetto**, puoi "contrassegnare" il testo come codice con un doppio apice ``: `` print () ``.

Le liste sono semplici come in Markdown:

- primo articolo
- Secondo elemento
     - Sottoelemento

oppure

* Primo elemento
* Secondo elemento
     * Sottoelemento

Le tabelle sono molto semplici da inserire:

=========== ========
Stato       Capitale
=========== ========
Francia     Parigi
Giappone    Tokio
=========== ========

Anche le tabelle più complesse possono essere inserite facilmente (colonne e/o righe unite) ma ti suggerisco di leggere la documentazione completa per questo :)

Esistono diversi modi per creare collegamenti:

- Aggiungendo un underscore dopo una parola: Github_ e aggiungendo l'URL di destinazione dopo il testo (questo metodo ha il vantaggio di non inserire URL non necessari all'interno del testo leggibile).
- Digitando un URL completo: https://github.com/ (verrà automaticamente convertito in un collegamento)
- Utilizzando una sintassi simile a Markdown: `Github <https://github.com/>`_ .

Si noti che devono esserci tanti caratteri di uguale quanti caratteri del titolo.

Anche i titoli normali usano caratteri di uguale, ma solo sotto¶

I sottotitoli usano i trattini¶

E i sotto-sottotitoli le tildi¶

Puoi inserire il testo in corsivo o in grassetto, puoi «contrassegnare» il testo come codice con un doppio apice ``: `` print () ``.

Le liste sono semplici come in Markdown:

primo articolo
Secondo elemento

- Sottoelemento

oppure

Primo elemento
Secondo elemento

* Sottoelemento

Le tabelle sono molto semplici da inserire:

Stato	Capitale
Francia	Parigi
Giappone	Tokio

Anche le tabelle più complesse possono essere inserite facilmente (colonne e/o righe unite) ma ti suggerisco di leggere la documentazione completa per questo :)

Esistono diversi modi per creare collegamenti:

Aggiungendo un underscore dopo una parola: Github e aggiungendo l’URL di destinazione dopo il testo (questo metodo ha il vantaggio di non inserire URL non necessari all’interno del testo leggibile).
Digitando un URL completo: https://github.com/ (verrà automaticamente convertito in un collegamento)
Utilizzando una sintassi simile a Markdown: Github .

https://getbootstrap.com/docs/4.0/components/card/#border

raw:: html

<div class=»card border-primary mb-3» style=»max-width: 18rem;»> <div class=»card-header»>Header</div> <div class=»card-body text-primary»> <h5 class=»card-title»>Primary card title</h5> <p class=»card-text»>Some quick example text to build on the card title and make up the bulk of the card’s content.</p>

</div>

</div> <div class=»card border-secondary mb-3» style=»max-width: 18rem;»>

<div class=»card-header»>Header</div> <div class=»card-body text-secondary»>

<h5 class=»card-title»>Secondary card title</h5> <p class=»card-text»>Some quick example text to build on the card title and make up the bulk of the card’s content.</p>

</div>

</div> <div class=»card border-success mb-3» style=»max-width: 18rem;»>

<div class=»card-header»>Header</div> <div class=»card-body text-success»>

<h5 class=»card-title»>Success card title</h5> <p class=»card-text»>Some quick example text to build on the card title and make up the bulk of the card’s content.</p>

</div>

</div> <div class=»card border-danger mb-3» style=»max-width: 18rem;»>

<div class=»card-header»>Header</div> <div class=»card-body text-danger»>

<h5 class=»card-title»>Danger card title</h5> <p class=»card-text»>Some quick example text to build on the card title and make up the bulk of the card’s content.</p>

</div>

</div> <div class=»card border-warning mb-3» style=»max-width: 18rem;»>

<div class=»card-header»>Header</div> <div class=»card-body text-warning»>

<h5 class=»card-title»>Warning card title</h5> <p class=»card-text»>Some quick example text to build on the card title and make up the bulk of the card’s content.</p>

</div>

</div> <div class=»card border-info mb-3» style=»max-width: 18rem;»>

<div class=»card-header»>Header</div> <div class=»card-body text-info»>

<h5 class=»card-title»>Info card title</h5> <p class=»card-text»>Some quick example text to build on the card title and make up the bulk of the card’s content.</p>

</div>

</div> <div class=»card border-light mb-3» style=»max-width: 18rem;»>

<div class=»card-header»>Header</div> <div class=»card-body»>

<h5 class=»card-title»>Light card title</h5> <p class=»card-text»>Some quick example text to build on the card title and make up the bulk of the card’s content.</p>

</div>

</div> <div class=»card border-dark mb-3» style=»max-width: 18rem;»>

<div class=»card-header»>Header</div> <div class=»card-body text-dark»>

<h5 class=»card-title»>Dark card title</h5> <p class=»card-text»>Some quick example text to build on the card title and make up the bulk of the card’s content.</p>

</div>

</div>

3 - embedding¶

Esempio di tabella¶

CARATTERE	SIGNIFICATO	ESEMPIO
`*`	corrisponde a zero, uno o più del carattere precedente	`Ah*` corrisponde a `Ahhhhh` o `A`
`?`	corrisponde a zero o uno del carattere precedente	`Ah?` corrisponde a `A` o `Ah`
`+`	corrisponde a uno o più del carattere precedente	`Ah+` corrisponde a `Ah` o `Ahhh` ma non a `A`
`\`	Usato per escludere un carattere speciale	`Hungry\?` corrisponde a `Hungry?`
`.`	Wildcard, carattere jolly, corrisponde a qualsiasi carattere	`do.*` corrisponde a `dog`, `door`, `dot`, etc.
`( )`	Gruppo di caratteri Vedi ad esempio `\|`
`[ ]`	corrisponde ad un range di caratteri	`[cbf]ar` corrisponde a `car`, `bar`, o `far`; `[0-9]+` corrisponde a qualsiasi numero intero positivo tra 0 e 9 inclusi; `[a-zA-Z]` corrisponde a lettere ASCII `a-z` (maiuscole e minuscole); `[^0-9]` corrisponde a qualsiasi carattere non numerico
`\|`	corrisponde al precedente OR successivo carattere/gruppo	`(Mon)\|(Tues)day` corrisponde a `Monday` o `Tuesday`
`{ }`	corrisponde aa un numero specificato di occorrenze del carattere precedente	`[0-9]{3}` corrisponde a `315` ma non a `31`; `[0-9]{2,4}` corrisponde a `18`, `125` e `1234`; `[0-9]{2,}` corrisponde a `1234567…`
`^`	Inizio di una stringa o all'interno di un intervallo di caratteri [] negazione.	`^http` corrisponde stringhe che iniziano con `http`, ad esempio un URL. `[^0-9]` corrisponde a qualsiasi carattere diverso da `0-9`.
`$`	Fine stringa	`ta$` corrisponde a `cascata` e no a `tavola`

Esempio di video incorporato su file `.MD`¶

Raduno della community di OpendataSicilia del 9 e 10 novembre 2018 a Palermo.

Adempimento	Capo, articolo
Si tratta di adempimenti volontari del titolare mediante i quali può implementare importanti misure di sicurezza dei trattamenti e dimostrare la conformità delle attività di trattamento ai requisiti stabiliti dal Regolamento.	IV, 40-42

Curriculum Vitae¶

aggiornato al 21 giugno 2019

INFORMAZIONI PERSONALI PERSONAL INFO	Descrizione
nome e cognome name and last name	Ciro Spataro
indirizzo di lavoro current work address	Via dello Spirito Santo, 35, Palermo, Italy (lat.: 38.117622, long.: 13.357408)
telefono ufficio office phone	+390917407340
email ufficio office email	c.spataro@comune.palermo.it
email personale personal email	cirospat@gmail.com
data di nascita date of birth	26.04.1967
titolo di studio study degree	Diploma di Geometra conseguito presso l’I.T.G. “Filippo Parlatore” di Palermo, nel 1985 Diploma of Geometry in 1985
ESPERIENZA LAVORATIVA WORK EXPERIENCE	Descrizione
periodi periods	Dal novembre 1989 ad oggi presso il Comune di Palermo ⇎ 1989-2002: al Settore Urbanistica ⇎ 2002-2013: al Settore Ambiente ⇎ 2013-2017: all'Area Innovazione Tecnologica / open data ⇎ 2016-2017: Posizione Organizzativa su Innovazione, pubblicazione e open data presso Area Innovazione Tecnologica ⇎ 2018-posizione corrente: Servizio Innovazione, UO transizione al digitale.
nome del datore di lavoro name of employer	Comune di Palermo Municipality of Palermo
link a progetti UE in cui è stato coinvolto link to UE project in which has been involved	⇎ cied innovation and economic development ⇎ euro-emas Emas UE scheme ⇎ etiv Emas UE scheme and peer review ⇎ medclima climate protection action plan ⇎ urban-matrix exchange of good practices in urban management.
principali mansioni e responsabilità main functions and responsibilities	⇎ Tecnico nella redazione e gestione di progetti negli ambiti della sostenibilità nelle aree urbane, dell'innovazione tecnologica e open data. ⇎ Posizione Organizzativa su "Innovazione tecnologica, pubblicazione e open data", 2016-17-18 presso l'Area Innovazione Tecnologica. Technician involved in projects management related to sustainability in urban areas, innovation technology, and open data. Organizational Position concerning "Innovation technology, publication and open data" 2016-17-18 in Innovation Technology municipal department.
attitudini attitudes	⇎ Propensione alla risoluzione delle criticità attraverso l’ascolto e il confronto con colleghi, funzionari e dirigenti, per individuare azioni correttive. Attitudine alla progettualità, alla condivisione della conoscenza e dei dati. ⇎ Analisi dei processi partecipativi con tecniche di codesign. ⇎ Attitudine al lavoro in team multidisciplinari. Propensity to solve critical issues through listening and comparing with colleagues, officials and executives, in order to identify corrective actions. Attitude to project design, sharing knowledge and data. Participatory process analysis with co-design techniques. Attitude to work in multidisciplinary teams
LINGUE STRANIERE FOREIGN LANGUAGES	Descrizione
Lingua Language	Inglese English
lettura reading	buona good
scrittura writing	buona good
espressione orale / oral	buona good
Lingua Language	Spagnolo Spanish
lettura reading	buona medium
scrittura writing	media low
espressione orale oral	media medium
FORMAZIONE TECNICA TECHNICAL SKILL	Descrizione
formazione training scheme	Partecipazione a percorsi formativi ⇎ Produzione, gestione e conservazione dei documenti digitali e/o digitalizzati (II Livello) ⇎ Percorso INPS_Valore_PA - Università Lumsa in collaborazione con Formel, 2019 ⇎ Progettazione energetica degli edifici, 2008 ⇎ I sistemi di gestione ambientale, 2004 ⇎ Efficienza energetica, normativa e meccanismi di incentivazione, 2007 ⇎ Urban Management, 2008 ⇎ I sistemi fotovoltaici connessi in rete, installazione e collaudo, 2004 ⇎ Pubblica Amministrazione e Sviluppo Urbano Sostenibile, 2003 ⇎ Gli impianti solar cooling, 2008 ⇎ Tecnologie energetiche rinnovabili, 2006 ⇎ Parsec ciclo di vita del progetto: gestione dei rischi nei progetti, budgeting e rendicontazione, 2008 ⇎ La direzione per obiettivi, 2006 ⇎ Formez Partecipazione al corso online del FormezPA sugli open data, 2014 eventipa.formez.it/node/29227 ⇎ Formez Partecipazione al corso online del FormezPA sugli open data, 2015 eventipa.formez.it/node/57587 ⇎ Formez Partecipazione al corso online del Formez sull'e-leadership, 2015 eventipa.formez.it/node/57584 ⇎ Formez Partecipazione da relatore al webinar del Formez sulla pubblicazione documentale della PA su Docs Italia, eventipa.formez.it/node/148190 ⇎ Realizzazione e aggiornamento di una piattaforma di formazione open data
abilità tecniche technical skill	⇎Uso di database per la costruzione di mappe interattive ⇎ Uso dei servizi Google Drive servizi per la produttività quotidiana ⇎ Uso della piattaforme Read the Docs e Docs Italia per la pubblicazione documentale delle Pubbliche Amministrazioni, secondo le linee guida del Team Trasformazione Digitale (AgID) ⇎ Competenze organizzative e di monitoraggio attività con l'ausilio di indicatori, acquisite durante l'esperienza di gestione dei progetti di partenariato transnazionale co-finanziati dall'UE
partecipazione a convegni e seminari, pubblicazioni, collaborazione a riviste, ecc. participation in conferences and seminars, publications, collaboration in magazines, etc.	Pubblicazioni: ⇎ Redazione delle Linee Guida comunali open data in maniera partecipata, adottate dal Comune di Palermo con Deliberazione di GM n. 252/2013 e n. 97/2017 ⇎ Realizzazione e aggiornamento del portale didattico su open data per i referenti open data del Comune di Palermo ⇎ Pubblicazione articoli sulla community online degli Innovatori della Pubblica Amministrazione http://www.innovatoripa.it/blogs/cirospataro ⇎ Pubblicazioni articoli Pubblica Amministrazione Digitale sulla community Medium Docenza: ⇎ Compa FVG Centro di competenza per la pubblica amministrazione Friuli Venezia Giulia, 22 giugno 2018, percorso open data del comune di Palermo ⇎ Redazione FPA, gennaio 2019. Come pubblicare documenti online con il format di 'Read the Docs' per fruire testi anche su dispositivi mobili e con efficaci sistema di ricerca tag nel testo
INTERESSI E RETI INTERESTS AND NETWORKING	Descrizione
interessi hobbies	photography, trekking, mtbiking, snorkelling, tutorial, civic hacking
attivo in reti active in networking	⇎ forum DocsItalia per l'attuazione dell'Agenda Digitale nella Pubblica Amministrazione ⇎ opendatasicilia open data network ⇎ mailing list opendatasicilia ⇎ medium.com/@cirospat articoli sulla Pubblica Amministrazione digitale ⇎ twitter.com/cirospat ⇎ linkedin.com/in/cirospataro ⇎ Pubblica Amministrazione Digitale e Agenda Digitale ⇎ Codice Amministrazione Digitale
profilo profile	cirospat.readthedocs.io

Il CV è disponibile a questo link per essere scaricato in diversi formati (pdf, odt, docx).

Attenzione

Questo è un messaggio sui cui prestare attenzione. Propensione alla risoluzione delle criticità attraverso l’ascolto e il confronto con colleghi, funzionari e dirigenti, per individuare azioni correttive. Attitudine alla progettualità, alla condivisione della conoscenza e dei dati

Attenzione Questo è un messaggio sui cui prestare attenzione. Propensione alla risoluzione delle criticità attraverso l’ascolto e il confronto con colleghi, funzionari e dirigenti, per individuare azioni correttive. Attitudine alla progettualità, alla condivisione della conoscenza e dei dati

Attenzione
Questo è un messaggio sui cui prestare attenzione. Propensione alla risoluzione delle criticità attraverso l’ascolto e il confronto con colleghi, funzionari e dirigenti, per individuare azioni correttive. Attitudine alla progettualità, alla condivisione della conoscenza e dei dati
Questo è un messaggio sui cui prestare attenzione. Propensione alla risoluzione delle criticità attraverso l’ascolto e il confronto con colleghi. Questo è un messaggio sui cui prestare attenzione. Propensione alla risoluzione delle criticità attraverso l’ascolto e il confronto con colleghi. directly in the editor or paste it from a Word Doc, PDF, Excel etc.

4- GGeditor-script-per-Google-Doc¶

{data creation of his document: 2017/01/10 - PM 01:11:42}

Cos’è questo documento¶

Questo documento contiene uno script con il codice sorgente che permette di trasmettere (in maniera automatica) su Github i contenuti editati in questo foglio, trasformandoli in sintassi del formato .RST.

Creando una copia di questo documento sul proprio Google Drive si copierà anche lo script che si trova su:

Strumenti / <> Editor di script GGeditor

I file contenuti nello script¶

Lo script è costituito dai seguenti files che si trovano dentro il repository https://github.com/cirospat/GGeditor_script:

conversion.html
explicitMarkup.html
generator.gs
github.html
properties.gs
reSTMetadata.gs
settings.html
sidebar.html
程式碼.gs

Release Note¶

New:

Convert table in HTML tags for preserving background color, column-span, row-span and column width.
Multiple github accounts.

Improved:

New «Settings» panel for accounts and document options.
In partial conversion, markups of table will keep the same as it is in whole document conversion.

(Release note dal creatore dello script di GGeditor)

Importante

Questo documento si trova al link: https://docs.google.com/document/d/14soShDfb2IoM5wSOHCSl6XwYmGJ2CK18jEwHXaWqWho/edit?usp=sharing

class speciale¶: This is a «special» chapter. Questo documento contiene uno script con il codice sorgente che permette di trasmettere (in maniera automatica) su Github i contenuti editati in questo foglio, trasformandoli in sintassi del formato .RST. Creando una copia di questo documento sul proprio Google Drive si copierà anche lo script che si trova su: Strumenti / <> Editor di script GGeditor

See the Pen CSS Goey footer by Zed Dash (@z-) on CodePen.

Far leggere un file in formato `.MD` a ReadtheDocs¶

autore: Ciro Spataro
issue: #106 fornitore ricetta mastro Andrea Borruso

{{% pageinfo %}} This is a placeholder page that shows you how to use this template site. {{% /pageinfo %}}

Problema¶

Se voglio far leggere un file .MD a ReadtheDocs, oltre ai file .RST, quali impostazioni devo settare e dove li devo settare su Github?

Soluzione¶

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:

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..

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.

Se il progetto su Read the Docs non dovesse compilare¶

In questo periodo (gennaio 2020) c”è un bug, seguire la procedura illustrata di seguito per permettere a Read the Docs di compilare il progetto ospitato su Github.

A questo link https://docs.readthedocs.io/en/stable/guides/wipe-environment.html viene spiegato come agire in maniera semplice.

Wiping a Build Environment

Sometimes it happen that your Builds start failing because the build environment where the documentation is created is stale or broken. This could happen for a couple of different reasons like pip not upgrading a package properly or a corrupted cached Python package.

In any of these cases (and many others), the solution could be just wiping out the existing build environment files and allow Read the Docs to create a new fresh one.

Follow these steps to wipe the build environment:

Go to Versions
Click on the Edit button of the version you want to wipe on the right side of the page
Go to the bottom of the page and click the wipe link, next to the “Save” button

NOTE: By wiping the documentation build environment, all the rst, md, and code files associated with it will be removed but not the documentation already built (HTML and PDF files). Your documentation will still be online after wiping the build environment.

Now you can re-build the version with a fresh build environment!

Esempio di Iframe dentro un file `Markdown`¶

Ciclo di webinar dedicati all’innovazione digitale organizzato da FormezPA nell’ambito della convenzione con AGID «ItaliaLogin» servizi d, Ciclo di webinar dedicati all’innovazione digitale organizzato da FormezPA nell’ambito della convenzione con AGID «ItaliaLogin» servizi d, Ciclo di webinar dedicati all’innovazione digitale organizzato da FormezPA nell’ambito della convenzione con AGID «ItaliaLogin» servizi d.

prova 1

Vai all”esempio¶

Vai all”esempio

Ecco l”esempio¶

Ecco l”esempio

Vai¶

Esempio di Google doc incorporato su file .MD ed esposto su Read the Docs

Nota = nell”iframe width è 1110 e height è 750

Fondamentali per la PA digitale.

|

<div class="event clearfix"><img width="60" src="{%}"/><div class="text"><h4 class="date">{%}</h4><h3><a href="{%}">{%}</a></h3><div class="button-link button-detail clearfix"><a href="{%}">SCOPRI</a></div></div></div>

Reti di impegno

Clicca sull'immagine di seguito, muoviti all'interno di essa con il mouse e aziona lo zoom per ingrandire i dettagli (con la rotellina del mouse)

Dove è (e qual è) l”istruzione da dare su Github per fare aprire su RTD i link in una pagina esterna?¶

autore: Ciro Spataro
issue: #116 fornitore ricetta Giovan Battista Vitrano

Obiettivo¶

Sui progetti di documentazione esposti su Read the Docs ad un determinato link voglio far aprire la pagina correlata in una pagina diversa da quella che sto leggendo.

Soluzione¶

Bisogna dare un istruzione sul file conf.py per fare aprire su RTD i link in una pagina esterna. L”istruzione è la seguente:

html_theme_options = {
    'style_external_links': True
}

Se si vogliono forzare tutte le pagine ad aprirsi in una nuova finestra, uno script su stackoverflow.com soddisfa l”esigenza. Basta aggiungere questo script nel file layout.html, prima della chiusara del blocco finale:

<!-- Adds target=_blank to external links -->
<script type="text/javascript">
   $(document).ready(function () { 
      $('a[href^="http://"], a[href^="https://"]').not('a[class*=internal]').attr('target', '_blank'); }); 
</script>

Messaggio di “build fails”: [cannot import name “PackageFinder”]¶

autore: Ciro Spataro
issue: #106 - aiuto nell”individuazione della soluzione: Andrea Borruso

Può capitare che durante la procedura di compilazione del progetto su Read the Docs appaia un messaggio: “cannot import name “PackageFinder” from “pip._internal.index”. Ciò comporta la non compilazione del progetto su Read the Docs, quindi gli aggiornamenti apportati sulle pagine di Github non vengono renderizzati sulle pagine HTML di Read the Docs.

La causa¶

Dall”issue del 20 gennaio 2020

Currently all builds are failing because the automatic upgrade (since #4823) to pip 20.0 was buggy (see pypa/pip#7620). There’s now a 20.0.1 release which seems to have fixed the problem for others … but how can I force my readthedocs to also upgrade to the .1 version?

La soluzione¶

Da Read the Docs / Wiping a Build Environment

A volte capita che le tue build inizino a fallire perché l”ambiente di build in cui viene creata la documentazione è obsoleto o danneggiato.

In uno di questi casi (e molti altri), la soluzione potrebbe essere semplicemente cancellare i file dell”ambiente di build esistente e consentire a Leggi i documenti di crearne uno nuovo.

Seguire questi passaggi per cancellare l”ambiente di compilazione:

Vai alle “Versioni”
Fare clic sul pulsante “Modifica” della versione che si desidera cancellare sul lato destro della pagina
Vai in fondo alla pagina e fai clic sul collegamento di Wype (cancellazione), accanto al pulsante «Salva».

Nota: Pulendo l”ambiente di creazione della documentazione (attraverso il «Wype»), verranno rimossi tutti i file rst, md e code associati ma non la documentazione già creata (file HTML e PDF). La documentazione sarà ancora online dopo aver cancellato l”ambiente di compilazione.

Ora è possibile ricostruire la versione con un nuovo ambiente di compilazione! Nella pagina «compilazioni» del progetto Read the Docs cliccare su «Versione di Compilazione» e una uova compilazione sarà avviata.

Informativa privacy estesa¶

In linea con la legislazione Europea, è fondamentale che ogni utente del sito web comprenda cosa sono i cookie e per quale motivo vengono utilizzati, in modo che gli utenti stessi possano decidere consapevolmente se accettarne l’utilizzo o no sui loro dispositivi.

Un cookie è un piccolo file di testo contenente un numero di identificazione univoco che viene trasferito dal sito web sul disco rigido del vostro computer attraverso un codice anonimo in grado di identificare il computer ma non l’utente e di monitorare passivamente le vostre attività sul sito.

I cookie possono essere classificati in due categorie, in base alle loro funzionalità:

Cookie tecnici (di cui fanno parte i cookie sulle prestazioni e i cookie funzionali)
Cookie profilanti (di cui fanno parte i cookie legati alle pubblicità)

Il sito utilizza solo il primo tipo di cookie, di tipo tecnico, per i quali non è richiesto alcun consenso.

Nel dettaglio vengono utlizzati le seguenti tipologie di cookie:

Cookie strettamente necessari
Questi cookie sono essenziali al fine di permettere la navigazione del sito web e l’utilizzo delle sue funzionalità, come ad esempio l’accesso ad alcune aree protette. Senza questi cookie, alcune funzionalità richieste come ad esempio il login al sito o l’inserimento degli articoli da parte dei collaboratori non potrebbero essere fornite.

Cookie sulle prestazioni
Questi cookie raccolgono informazioni su come gli utenti utilizzano il sito web, ad esempio quali pagine vengono visitate più spesso e se gli utenti ricevono messaggi di errore da queste pagine. Questi cookie non raccolgono informazioni che identificano un visitatore specifico. Tutte le informazioni raccolte da questi cookie sono aggregate e quindi anonime. Vengono utilizzate unicamente per migliorare il funzionamento del sito web.

Cookie di analisi di traffico anonimizzati

Questo sito web utilizza inoltre i cookie di Google Analytics, un servizio di analisi web fornito da Google. Le informazioni generate dal cookie sull’utilizzo del sito web da parte vostra (compreso il vostro indirizzo IP) verranno trasmesse e depositate presso i server di Google che utilizzerà queste informazioni allo scopo di tracciare ed esaminare il vostro utilizzo del sito web, compilare report sulle attività svolte sul sito web e fornire altri servizi relativi alle attività e all’utilizzo di Internet. I dati generati da Google Analytics sono conservati da Google così come indicato nella Informativa reperibile al seguente link.

L’utente può disabilitare in modo selettivo l’azione di Google Analytics installando sul proprio browser la componente di opt-out fornito da Google. Per disabilitare l’azione di Google Analytics, si rinvia al link di seguito indicato: https://tools.google.com/dlpage/gaoptout

Cookie funzionali

Questi cookie consentono al sito web di ricordare le scelte che avete effettuato (come il vostro username, la vostra lingua o l’area geografica in cui vivete) al fine di ottimizzare e fornire funzionalità più avanzate. Questi cookie possono inoltre essere utilizzati per fornire funzionalità da voi richieste come ad esempio la visualizzazione di un video o la possibilità di commentare sul sito. Queste informazioni raccolte dai cookie possono essere anonime e non devono tracciare la navigazione e le attività dell’utente su altri siti web. Vi preghiamo di considerare che alcune funzionalità del sito web potrebbero essere ridotte o non disponibili disabilitando i cookie. Nel dettaglio, gli utenti possono controllare, eliminare o impedire il caricamento di cookie agendo sui loro browser così come sotto indicato.

Pubblicità¶

Sono presenti annunci di pubblicità etica di Read the Docs che rispetta la privacy degli utenti.
La pubblicità etica è la fonte princiaple del progetto Read the Docs.

Titolo del Read the Docs¶

1 - Questa è solo una bozza. Direttive su RST¶

2 - Un po di sintassi RST¶

Anche i titoli normali usano caratteri di uguale, ma solo sotto¶

I sottotitoli usano i trattini¶

E i sotto-sottotitoli le tildi¶

3 - embedding¶

Esempio di tabella¶

Esempio di video incorporato su file .MD¶

Curriculum Vitae¶

4- GGeditor-script-per-Google-Doc¶

Cos’è questo documento¶

I file contenuti nello script¶

Release Note¶

Far leggere un file in formato .MD a ReadtheDocs¶

Problema¶

Soluzione¶

Se il progetto su Read the Docs non dovesse compilare¶

Esempio di Iframe dentro un file Markdown¶

Vai all”esempio¶

Ecco l”esempio¶

Vai¶

Dove è (e qual è) l”istruzione da dare su Github per fare aprire su RTD i link in una pagina esterna?¶

Obiettivo¶

Soluzione¶

Messaggio di “build fails”: [cannot import name “PackageFinder”]¶

La causa¶

La soluzione¶

Informativa privacy estesa¶

Cookie di terze parti¶

Widget Social Network¶

Pubblicità¶

Come disabilitare i cookie mediante configurazione del browser¶

1 - Questa è solo una bozza. Direttive su `RST`¶

Esempio di video incorporato su file `.MD`¶

Far leggere un file in formato `.MD` a ReadtheDocs¶

Esempio di Iframe dentro un file `Markdown`¶