-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation.html
executable file
·128 lines (105 loc) · 6.19 KB
/
documentation.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
<!DOCTYPE html>
<html lang="en">
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Documentation</title>
<link rel="stylesheet" href="https://www.w3schools.com/w3css/4/w3.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Montserrat">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<!-- Fichiers CSS additionnel-->
<link rel="stylesheet" href="styles/additionnalStyle.css?v=<?= filemtime('styles/additionnalStyle.css') ?>">
<!-- Fichiers CSS slideShadow-->
<link rel="stylesheet" href="https://maxst.icons8.com/vue-static/landings/line-awesome/line-awesome/1.3.0/css/line-awesome.min.css">
<link rel="stylesheet" href="styles/styles.css">
<!-- Favicon -->
<link rel="shortcut icon" type="image/png" href="images/mobilitydb-favicon.png"/>
<body>
<!-- Navbar -->
<div w3-include-html="navbar.html"></div>
<!-- User's Manual -->
<div class="w3-row-padding w3-padding-top-64 w3-container">
<div class="w3-content">
<div class="w3-margin-right">
<h1>User's Manual </h1>
<p>Pregenerated versions of the documentation are available here</p>
</div>
<table class="doclink">
<tr>
<td class="w3-center w3-padding-large w3-block w3-light-grey" >English:</td>
<td class="w3-center"><a class="w3-button mobdb-blue w3-padding-large w3-block" href="https://mobilitydb.github.io/MobilityDB/master/" target="_blank">HTML</a></td>
<td class="w3-center"><a class="w3-button mobdb-blue w3-padding-large w3-block" href="https://mobilitydb.github.io/MobilityDB/master/mobilitydb-manual.pdf" target="_blank">PDF</a></td>
<td class="w3-center"><a class="w3-button mobdb-blue w3-padding-large w3-block" href="https://mobilitydb.github.io/MobilityDB/master/mobilitydb-manual.epub" target="_blank">EPUB</a></td>
</tr>
<tr>
<td class="w3-center w3-light-grey">Spanish:</td>
<td class="w3-center"><a class="w3-button mobdb-blue w3-padding-large w3-block" href="https://mobilitydb.github.io/MobilityDB/master/es/" target="_blank">HTML</a></td>
<td class="w3-center"><a class="w3-button mobdb-blue w3-padding-large w3-block" href="https://mobilitydb.github.io/MobilityDB/master/es/mobilitydb-manual.pdf" target="_blank">PDF</a></td>
<td class="w3-center"><a class="w3-button mobdb-blue w3-padding-large w3-block" href="https://mobilitydb.github.io/MobilityDB/master/es/mobilitydb-manual.epub" target="_blank">EPUB</a></td>
</tr>
</table>
<p>Alternatively, you can generate the user's manual in HTML, PDF, and EPUB formats.</p>
<div class="w3-panel w3-card w3-light-grey">
<p> The manual is generated in English and in other available languages (currently only Spanish). For this, it is necessary to specify appropriate options in the <code>cmake</code> command as follows:
<div class="w3-code-override">
<ul dir="auto">
<li><code style="background-color: lightgray">DOC_ALL</code>: Generate in HTML, PDF, and EPUB formats</li>
<li><code style="background-color: lightgray">DOC_HTML</code>: Generate in HTML format</li>
<li><code style="background-color: lightgray">DOC_PDF</code>: Generate in PDF format</li>
<li><code style="background-color: lightgray">DOC_EPUB</code>: Generate in EPUB format</li>
<li><code style="background-color: lightgray">LANG_ALL</code>: Generate in all available languages</li>
<li><code style="background-color: lightgray">ES</code>: Generate the Spanish documentation</li>
</ul>
</div>
<p dir="auto">For example, the following command generates the documentation in all formats and in all languages.</p>
<div class="w3-code-override">
cmake -D DOC_ALL=true -D LANG_ALL=true ..
</div>
<p dir="auto">As another example, the following command generates the English documentation in PDF.</p>
<div class="w3-code-override">
cmake -D DOC_PDF=true ..<br>
make doc
</div>
<p dir="auto">The resulting documentation will be generated in the <code>doc</code> directory of the build directory.</p>
<br>
</div>
</div>
</div>
<!-- Developer's Documentation -->
<div class="w3-row-padding w3-padding-top-64 w3-container w3-light-grey">
<div class="w3-content">
<div class="w3-margin-right">
<h1>Developer's Documentation</h1>
<p>A pregenerated version of the documentation is available.</p>
</div>
<table class="doclink">
<tr>
<td class="w3-center"><a class="w3-button mobdb-blue w3-padding-large w3-block" href="https://mobilitydb.github.io/MobilityDB/master-dev/" target="_blank">HTML</a></td>
<td></td>
<td></td>
</tr>
</table>
<p>Alternatively, you can generate the English developer's documentation in HTML format.</p>
<div class="w3-panel w3-card w3-light-grey">
<p>For this, it is necessary to add the option DOC_DEV in the cmake command as follows:</p>
<div class="w3-code-override notranslate">
cmake -D DOC_DEV=true ..<br>
make doc_dev
</div>
<p>The resulting HTML documentation will be generated in the doxygen directory of the build directory.</p>
<br>
</div>
</div>
</div>
<!-- Footer -->
<div w3-include-html="footer.html"></div>
</body>
<script src="js/includeHTML.js"></script>
<script>includeHTML();</script>
<script>
((window.gitter = {}).chat = {}).options = {
room: 'MobilityDBProject/MobilityDB'
};
</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
</html>