-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
274 lines (164 loc) · 10.7 KB
/
index.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
<!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>Welcome to OT1 - Text Indexing’s documentation! — OT1 - Text Indexing documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="_static/collapsible-lists/js/CollapsibleLists.compressed.js"></script>
<script type="text/javascript" src="_static/collapsible-lists/js/apply-collapsible-lists.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/collapsible-lists/css/tree_view.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="C++ Backend" href="exhale/docs_root.html" />
</head>
<body class="wy-body-for-nav">
<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="#" class="icon icon-home"> OT1 - Text Indexing
</a>
<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">
<p class="caption"><span class="caption-text">Doxygen C++ Backend Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="exhale/docs_root.html">C++ Backend</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">OT1 - Text Indexing</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="#">Docs</a> »</li>
<li>Welcome to OT1 - Text Indexing’s documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-ot1-text-indexing-s-documentation">
<h1>Welcome to OT1 - Text Indexing’s documentation!<a class="headerlink" href="#welcome-to-ot1-text-indexing-s-documentation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="prerequis">
<h2>Prérequis<a class="headerlink" href="#prerequis" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p>Installer node.js ainsi que npm (installé avec node)</p></li>
<li><p>Installer le package angular-cli globalement
- Dans le dossier viewer, executer <cite>make install-angular</cite></p></li>
<li><p>Install les packages locaux
- Dans le dossier viewer, executer <cite>make install-npm-packages</cite></p></li>
</ul>
</div>
<div class="section" id="process">
<h2>Process<a class="headerlink" href="#process" title="Permalink to this headline">¶</a></h2>
<p>La commande <cite>make build-and-run</cite> va compiler le viewer et le copier dans le serveur puis lancer le serveur sur un port indiqué.</p>
<p>Plus tard pour relancer le serveur sans recompiler le viewer <cite>make run</cite></p>
</div>
<div class="section" id="ouvrir-le-viewer">
<h2>Ouvrir le viewer<a class="headerlink" href="#ouvrir-le-viewer" title="Permalink to this headline">¶</a></h2>
<p>Rendez vous sur votre navigateur préféré et tapez :</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>localhost:<le_port_donné_par_le_serveur>
</pre></div>
</div>
<p>Normalement, le port est le <strong>1337</strong>.</p>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Doxygen C++ Backend Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="exhale/docs_root.html">C++ Backend</a><ul>
<li class="toctree-l2"><a class="reference internal" href="exhale/docs_root.html#class-hierarchy">Class Hierarchy</a></li>
<li class="toctree-l2"><a class="reference internal" href="exhale/docs_root.html#file-hierarchy">File Hierarchy</a></li>
<li class="toctree-l2"><a class="reference internal" href="exhale/docs_root.html#full-api">Full API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="exhale/docs_root.html#namespaces">Namespaces</a></li>
<li class="toctree-l3"><a class="reference internal" href="exhale/docs_root.html#classes-and-structs">Classes and Structs</a></li>
<li class="toctree-l3"><a class="reference internal" href="exhale/docs_root.html#enums">Enums</a></li>
<li class="toctree-l3"><a class="reference internal" href="exhale/docs_root.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="exhale/docs_root.html#variables">Variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="exhale/docs_root.html#typedefs">Typedefs</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="sphinx-documentation-build-requirements">
<h2>Sphinx Documentation build requirements<a class="headerlink" href="#sphinx-documentation-build-requirements" title="Permalink to this headline">¶</a></h2>
<p>Text indexation project is documented with a sphinx documentation with doxygen (C++ code) and Open API (fka Swagger) integrations.
Please, browse to <a href="#id1"><span class="problematic" id="id2">`./build/sphinx/html/index.html`__</span></a> once you have built documentation.</p>
<p>In order to build project documentation, you first need to install a conda distribution, e.g. <a class="reference external" href="https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html">miniconda</a> or <a class="reference external" href="https://www.anaconda.com/distribution/">anaconda</a>
Then, you will be able to create a conda environement from <a class="reference external" href="./environement.yml">./environement.yml</a> file. This conda environement brings all dependencies needed to build projet documentation:
The conda environement includes sphinx documentation framework, doxygen for C++ code documentation, Breathe which makes the bridge between doxygen and sphinx, sphinxcontrib-openapi integrating Open API (fka Swagger) to sphinx documentation, sphinx_rtd_theme sphinx theme, exhale (automatic breath/doxygen documentation), …</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># create conda environement (documentation build dependencies are</span>
<span class="c1"># installed in an isolated conda environement named 'text_indexing_docs')</span>
conda env create -f ./environement.yml
<span class="c1"># Once created, you can activate conda environement in order to build documentation</span>
conda activate text_indexing_docs
</pre></div>
</div>
<p>Then, you can (re)build doxygen and sphinx documentation using provided <a class="reference external" href="./makefile">./makefile</a> (or <a class="reference external" href="./make.bat">./make.bat</a> on windows):</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make html
</pre></div>
</div>
<p>Note that doxygen is now built by exhale extension when running sphinx (see <a class="reference external" href="./source/config.py">./source/config.py</a> ).
Once documentation successfully built, you can browse to generated documentation main page: <a class="reference external" href="./build/sphinx/html/index.html">./build/sphinx/html/index.html</a></p>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
<a class="reference internal image-reference" href="https://www.insa-lyon.fr/sites/www.insa-lyon.fr/files/logo-coul.jpg"><img alt="INSA Lyon - Projet 5IF OT1" class="align-center" src="https://www.insa-lyon.fr/sites/www.insa-lyon.fr/files/logo-coul.jpg" style="width: 354.40000000000003px; height: 102.0px;" /></a>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="exhale/docs_root.html" class="btn btn-neutral float-right" title="C++ Backend" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, Quentin Guye, Nathan Mesnard, Paul-Emmanuel Sotir, Tianjian Ye
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>