This repository has been archived by the owner on Oct 25, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathhelp.html
372 lines (264 loc) · 13 KB
/
help.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Help — EAGLEDOC 0.2 documentation</title>
<link rel="stylesheet" href="static/css/theme.css" type="text/css" />
<link rel="top" title="EAGLEDOC 0.2 documentation" href="index.html"/>
<link rel="prev" title="Simulatore Sensori" href="SimSensori.html"/>
<script src="static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> EAGLEDOC
</a>
<div class="version">
0.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="design.html">Design Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="volante.html">Volante</a></li>
<li class="toctree-l1"><a class="reference internal" href="webplatform.html">Web Platform</a></li>
<li class="toctree-l1"><a class="reference internal" href="sensori.html">Sensori</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Help</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#modify-rst">Modify .rst</a></li>
<li class="toctree-l2"><a class="reference internal" href="#install-sphinx">Install Sphinx</a></li>
<li class="toctree-l2"><a class="reference internal" href="#create-a-project">Create a Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="#create-a-file-rst">Create a file.rst</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-project">Build Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="#themes-from-github">Themes From GitHub</a></li>
<li class="toctree-l2"><a class="reference internal" href="#output-to-git-hub">Output To Git Hub</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">EAGLEDOC</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Help</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<img alt="images/wallpaper.png" src="images/wallpaper.png" />
<div class="section" id="help">
<h1>Help<a class="headerlink" href="#help" title="Permalink to this headline">¶</a></h1>
<p>Qui troverai tutto quello che serve per installare <strong>Sphinx</strong> e creare pagine <strong>HTML</strong></p>
<div class="section" id="modify-rst">
<h2>Modify .rst<a class="headerlink" href="#modify-rst" title="Permalink to this headline">¶</a></h2>
<p>Questo punto del help mostra come tutti possono inserire le loro risorse partendo dalla nostra repository senza avere problemi</p>
<div class="highlight-sh"><div class="highlight"><pre>git clone https://github.com/eagletrt/eagletrt.github.io.git
<span class="nb">cd</span> eagletrt.github.io/EAGLEDOC
</pre></div>
</div>
<p>La cartella <strong>EAGLEDOC</strong> contiene tutti i file sorgente e multimediali che ci servono per generare gli html.
Una volta modificato un file, inserito nell <cite>index.rst</cite> o dove è necessario basterà prepararli per la repo.
Questi una volta che saranno pronti per la pubblicazione (vedi ultimo punto se vuoi sapere come funziona, altrimenti copia-incolla-invio)
Per poi essere copiati e incollati nela directory principale (eagletrt.github.io)</p>
<div class="highlight-sh"><div class="highlight"><pre>sudo python sphinxtogithub.py build/html
</pre></div>
</div>
<p>Verifichiamo le modifiche effettuate se ci torna tutto possiamo procedere</p>
<div class="highlight-sh"><div class="highlight"><pre>git status
</pre></div>
</div>
<p>Aggiungiamo, scriviamo un messaggio, <strong>pushiamelo</strong>!</p>
<div class="highlight-sh"><div class="highlight"><pre>git add .
git commit -m <span class="s2">"Ho fatto questo e quello"</span>
git push origin master
</pre></div>
</div>
</div>
<div class="section" id="install-sphinx">
<h2>Install Sphinx<a class="headerlink" href="#install-sphinx" title="Permalink to this headline">¶</a></h2>
<div class="highlight-sh"><div class="highlight"><pre>sudo apt-get install python-sphinx
mkdir sphinx-project
<span class="nb">cd</span> sphinx-project
</pre></div>
</div>
</div>
<div class="section" id="create-a-project">
<h2>Create a Project<a class="headerlink" href="#create-a-project" title="Permalink to this headline">¶</a></h2>
<div class="highlight-sh"><div class="highlight"><pre>sphinx-quickstart
</pre></div>
</div>
<p>Ora da terminale verrà richiesto di creare il progetto e bisognerà completare questi campi:</p>
<blockquote>
<div><p><a href="#id1"><span class="problematic" id="id2">*</span></a>Project Name</p>
<p><a href="#id3"><span class="problematic" id="id4">*</span></a>Author Name</p>
<p><a href="#id5"><span class="problematic" id="id6">*</span></a>Project version</p>
</div></blockquote>
<p>Gli altri basterà skipparli con enter.
Una volta terminata la creazione dei file necessari bisogna testare se è andato tutto a buon fine aprendo in <cite>_build/html</cite> l’index.html</p>
</div>
<div class="section" id="create-a-file-rst">
<h2>Create a file.rst<a class="headerlink" href="#create-a-file-rst" title="Permalink to this headline">¶</a></h2>
<p>Per generare nuove pagine bisogna creare un nuovo file <cite>.rst</cite> dove andranno scritti tutti i tag</p>
<div class="highlight-sh"><div class="highlight"><pre>touch file.rst
</pre></div>
</div>
<p>Ora passo a passo verrano mostrati i comandi necessari per creare una pagina:</p>
<blockquote>
<div><blockquote>
<div><ul>
<li><p class="first">Per quanto riguarda il titolo basterà scriverlo e nella riga sottostante mettere tanti “=” quanto la lunghezza della stringa del titolo</p>
</li>
<li><p class="first">Per aggiungere immagini alla pagina basterà creare una directory nella cartella del progetto e inserire le immagini</p>
<dl class="directive">
<dt id="directive-image">
<code class="descname">.. image::</code><code class="descclassname"> immagine</code><a class="headerlink" href="#directive-image" title="Permalink to this definition">¶</a></dt>
<dd><p>Esempio:</p>
<div class="highlight-python"><div class="highlight"><pre>.. image:: /images/wallpaper.png
</pre></div>
</div>
</dd></dl>
</li>
</ul>
</div></blockquote>
<ul>
<li><p class="first">Per aggiungere scritte testuali basterà scrivere il testo e verrà visualizzato</p>
</li>
<li><p class="first">Per aggiungere note</p>
<blockquote>
<div><dl class="directive">
<dt id="directive-note">
<code class="descname">.. note::</code><code class="descclassname"> </code><a class="headerlink" href="#directive-note" title="Permalink to this definition">¶</a></dt>
<dd><p>Esempio:</p>
<div class="highlight-python"><div class="highlight"><pre>.. note::
this is a note
</pre></div>
</div>
</dd></dl>
</div></blockquote>
</li>
<li><p class="first">Per aggiungere warning</p>
<blockquote>
<div><dl class="directive">
<dt id="directive-warning">
<code class="descname">.. warning::</code><code class="descclassname"> </code><a class="headerlink" href="#directive-warning" title="Permalink to this definition">¶</a></dt>
<dd><p>Esempio:</p>
<div class="highlight-python"><div class="highlight"><pre>.. warning::
this is a warning
</pre></div>
</div>
</dd></dl>
</div></blockquote>
</li>
<li><p class="first">Per aggiungere codice basterà specificare il tipo di linguaggio</p>
<blockquote>
<div><blockquote>
<div><dl class="directive">
<dt id="directive-code-block">
<code class="descname">.. code-block::</code><code class="descclassname"> linguaggio</code><a class="headerlink" href="#directive-code-block" title="Permalink to this definition">¶</a></dt>
<dd><p>Esempio:</p>
<div class="highlight-python"><div class="highlight"><pre>.. code-block:: sh
this is a code
</pre></div>
</div>
</dd></dl>
</div></blockquote>
<ul class="simple">
<li>Per rendere visualizabile la pagina html basterà in <cite>index.rst</cite> linkare il file inserendo in Contents il nome senza estensione ad esempio <cite>file</cite></li>
</ul>
</div></blockquote>
</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="build-project">
<h2>Build Project<a class="headerlink" href="#build-project" title="Permalink to this headline">¶</a></h2>
<p>Ora per creare effettivamente i file html si usa il comando make</p>
<div class="highlight-sh"><div class="highlight"><pre>sudo make clean
sudo make html
</pre></div>
</div>
<p>Per aprire il sito bisogna spostarsi su <cite>_build/html</cite> e aprire index.html</p>
</div>
<div class="section" id="themes-from-github">
<h2>Themes From GitHub<a class="headerlink" href="#themes-from-github" title="Permalink to this headline">¶</a></h2>
<p>Se non ancora installato scaricare pip oppure skippare al secondo comando</p>
<div class="highlight-sh"><div class="highlight"><pre>sudo apt-get install python-pip
pip install sphinx_rtd_theme
</pre></div>
</div>
<p>In <cite>conf.py</cite> modificare come segue</p>
<blockquote>
<div><p><a href="#id7"><span class="problematic" id="id8">*</span></a>import sphinx_rtd_theme</p>
<p><a href="#id9"><span class="problematic" id="id10">*</span></a>html_theme = “sphinx_rtd_theme”</p>
<p><a href="#id11"><span class="problematic" id="id12">*</span></a>html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]</p>
</div></blockquote>
<p>Questa procedura viene utilizzata per scaricare in locale sul pc ma effettivamente non vengono caricati i file nella directory del progetto, esiste un altro modo per caricarlo basta guardare su sphinx-doc dove oltre a questo è possibile vedere tutti i comandi che ho illustrato qui e inoltre è possibile vedere i file source di ogni singola pagina per impararne di nuovi.</p>
</div>
<div class="section" id="output-to-git-hub">
<h2>Output To Git Hub<a class="headerlink" href="#output-to-git-hub" title="Permalink to this headline">¶</a></h2>
<p>Una volta creati gli <cite>.html</cite> desiderati bisognerà utilizzare uno script per sistemare le reference che utilizza GitHub, ci sono tantissimi modi, io consiglio questo script.
Una volta clonato il progetto basterà seguire le istruzioni che trovate nella repo di <cite>michaeljones</cite>.</p>
<div class="highlight-sh"><div class="highlight"><pre>git clone https://github.com/michaeljones/sphinx-to-github
sudo python /sphinx-to-github/sphinxtogithub/sphinxtogithub.py ~/eagletrt.github.io/EAGLEDOC/build/html
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="SimSensori.html" class="btn btn-neutral" title="Simulatore Sensori" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Eagle Trento Racing Team.
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.2',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<script type="text/javascript" src="static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>