Merge all french translation and update instructions on how to build …

…doc for different languages
armadito · Nov 18, 2016 · 8e353ca · 8e353ca
2 parents 4f0e951 + dea5bcc
commit 8e353ca
Show file tree

Hide file tree

Showing 93 changed files with 1,368 additions and 1,363 deletions.
diff --git a/Makefile b/Makefile
@@ -15,9 +15,9 @@ endif
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source/$(doclanguage)
 # the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source/$(doclanguage)
 
 .PHONY: help
 help:
@@ -55,7 +55,7 @@ clean:
 
 .PHONY: html
 html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html/$(doclanguage)
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 

diff --git a/README.md b/README.md
@@ -6,13 +6,14 @@ Our documentation is available online at <http://armadito-av.readthedocs.io/en/l
 Build
 -----
 
-make clean && make html && firefox build/html/index.html
+make clean && make doclanguage?=fr html && firefox build/html/fr/index.html
+make clean && make doclanguage?=en html && firefox build/html/en/index.html
+...
+etc
+
 
 Thanks
 ------
 
 Thanks to readthedocs.org community for hosting our documentation on their servers.
 More about readthedocs.org : https://docs.readthedocs.io/en/latest/#
-
-
-
diff --git a/source/en_US/armadito_logo.png → source/armadito_logo.png b/source/en_US/armadito_logo.png → source/armadito_logo.png
diff --git a/source/en_US/compilation/index.rst → source/en/compilation/index.rst b/source/en_US/compilation/index.rst → source/en/compilation/index.rst
diff --git a/source/en_US/compilation/linux/clamav.rst → source/en/compilation/linux/clamav.rst b/source/en_US/compilation/linux/clamav.rst → source/en/compilation/linux/clamav.rst
diff --git a/source/en_US/compilation/linux/core.rst → source/en/compilation/linux/core.rst b/source/en_US/compilation/linux/core.rst → source/en/compilation/linux/core.rst
diff --git a/source/en_US/compilation/linux/gui.rst → source/en/compilation/linux/gui.rst b/source/en_US/compilation/linux/gui.rst → source/en/compilation/linux/gui.rst
diff --git a/source/en_US/compilation/linux/index.rst → source/en/compilation/linux/index.rst b/source/en_US/compilation/linux/index.rst → source/en/compilation/linux/index.rst
diff --git a/source/en_US/compilation/linux/moduleH1.rst → source/en/compilation/linux/moduleH1.rst b/source/en_US/compilation/linux/moduleH1.rst → source/en/compilation/linux/moduleH1.rst
diff --git a/source/en_US/compilation/linux/modulePDF.rst → source/en/compilation/linux/modulePDF.rst b/source/en_US/compilation/linux/modulePDF.rst → source/en/compilation/linux/modulePDF.rst
diff --git a/source/en_US/compilation/linux/scripts.rst → source/en/compilation/linux/scripts.rst b/source/en_US/compilation/linux/scripts.rst → source/en/compilation/linux/scripts.rst
diff --git a/source/en_US/compilation/windows/clamav.rst → source/en/compilation/windows/clamav.rst b/source/en_US/compilation/windows/clamav.rst → source/en/compilation/windows/clamav.rst
diff --git a/source/en_US/compilation/windows/core.rst → source/en/compilation/windows/core.rst b/source/en_US/compilation/windows/core.rst → source/en/compilation/windows/core.rst
diff --git a/source/en_US/compilation/windows/driver.rst → source/en/compilation/windows/driver.rst b/source/en_US/compilation/windows/driver.rst → source/en/compilation/windows/driver.rst
diff --git a/source/en_US/compilation/windows/gui.rst → source/en/compilation/windows/gui.rst b/source/en_US/compilation/windows/gui.rst → source/en/compilation/windows/gui.rst
diff --git a/source/en_US/compilation/windows/index.rst → source/en/compilation/windows/index.rst b/source/en_US/compilation/windows/index.rst → source/en/compilation/windows/index.rst
diff --git a/...ce/en_US/compilation/windows/moduleH1.rst → source/en/compilation/windows/moduleH1.rst b/...ce/en_US/compilation/windows/moduleH1.rst → source/en/compilation/windows/moduleH1.rst
diff --git a/...e/en_US/compilation/windows/modulePDF.rst → source/en/compilation/windows/modulePDF.rst b/...e/en_US/compilation/windows/modulePDF.rst → source/en/compilation/windows/modulePDF.rst
diff --git a/source/en_US/conf.py → source/en/conf.py b/source/en_US/conf.py → source/en/conf.py
@@ -10,7 +10,7 @@
 templates_path = ['_templates']
 source_suffix = '.rst'
 master_doc = 'index'
-project = u'armaditoav-en'
+project = u'ArmaditoAV'
 copyright = u'2016, Teclib'
 author = u'Teclib'
 version = u'1.0'
@@ -26,7 +26,7 @@
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 html_static_path = ['_static']
-htmlhelp_basename = 'armaditoavendoc'
+htmlhelp_basename = 'armaditoavdoc'
 
 latex_elements = {
 }

diff --git a/source/en_US/configuration/index.rst → source/en/configuration/index.rst b/source/en_US/configuration/index.rst → source/en/configuration/index.rst
diff --git a/source/en_US/configuration/linux.rst → source/en/configuration/linux.rst b/source/en_US/configuration/linux.rst → source/en/configuration/linux.rst
diff --git a/source/en_US/configuration/windows.rst → source/en/configuration/windows.rst b/source/en_US/configuration/windows.rst → source/en/configuration/windows.rst
diff --git a/source/en_US/contribute/index.rst → source/en/contribute/index.rst b/source/en_US/contribute/index.rst → source/en/contribute/index.rst
diff --git a/source/en_US/faq/index.rst → source/en/faq/index.rst b/source/en_US/faq/index.rst → source/en/faq/index.rst
diff --git a/source/en_US/index.rst → source/en/index.rst b/source/en_US/index.rst → source/en/index.rst
@@ -1,7 +1,7 @@
 .. Armadito documentation master file, created by
    sphinx-quickstart on Tue Apr 12 17:35:15 2016.
 
-.. image:: armadito_logo.png
+.. image:: ../armadito_logo.png
    :height: 78px
    :width: 78px
    :alt: armadito logo

diff --git a/source/en_US/installation/index.rst → source/en/installation/index.rst b/source/en_US/installation/index.rst → source/en/installation/index.rst
diff --git a/source/en_US/installation/linux.rst → source/en/installation/linux.rst b/source/en_US/installation/linux.rst → source/en/installation/linux.rst
diff --git a/source/en_US/installation/windows.rst → source/en/installation/windows.rst b/source/en_US/installation/windows.rst → source/en/installation/windows.rst
diff --git a/source/en_US/intro/index.rst → source/en/intro/index.rst b/source/en_US/intro/index.rst → source/en/intro/index.rst
diff --git a/source/en_US/licensing/index.rst → source/en/licensing/index.rst b/source/en_US/licensing/index.rst → source/en/licensing/index.rst
diff --git a/source/en_US/manual/index.rst → source/en/manual/index.rst b/source/en_US/manual/index.rst → source/en/manual/index.rst
diff --git a/source/en_US/resources/index.rst → source/en/resources/index.rst b/source/en_US/resources/index.rst → source/en/resources/index.rst
diff --git a/source/en/screenshots/Journal_tab.png b/source/en/screenshots/Journal_tab.png
diff --git a/source/en/screenshots/Scan_tab.png b/source/en/screenshots/Scan_tab.png
diff --git a/source/en/screenshots/Status_tab.png b/source/en/screenshots/Status_tab.png
diff --git a/source/en_US/screenshots/index.rst → source/en/screenshots/index.rst b/source/en_US/screenshots/index.rst → source/en/screenshots/index.rst
diff --git a/source/fr_FR/compilation/index.rst → source/fr/compilation/index.rst b/source/fr_FR/compilation/index.rst → source/fr/compilation/index.rst
@@ -3,6 +3,6 @@ Compilation
 
 .. toctree::
    :maxdepth: 2
-   
+
    linux/index.rst
    windows/index.rst
diff --git a/source/fr/compilation/linux/clamav.rst b/source/fr/compilation/linux/clamav.rst
@@ -0,0 +1,99 @@
+Armadito ClamAV module 
+======================
+
+**Armadito ClamAV** module correspond à l'intégration de libclamav bibliothèque dans Armadito-av. 
+
+Les sources sont publiquement disponibles sur github.com, vous pouvez l'obtenir avec la commande suivante :
+
+::
+
+   $ git clone https://github.com/armadito/armadito-mod-clamav.git -b DEV
+
+Les prérequis
+-------------
+
+Pour compiler le module Armadito ClamAV, vous avez besoin des outils suivants:
+
+- automake/autoconf
+- GNU make
+- C compiler
+- libclamav library and headers
+
+.. warning:: Assurez-vous d'avoir **Armadito core** bibliothèque avant d'essayer de construire ce module.
+
+- Ubuntu: 
+
+::
+
+     apt-get install libclamav-dev
+
+Configuration
+-------------
+
+
+Pour initialiser la construction en utilisant automake, autoconf et tools, un script shell 
+**autogen.sh** est prévu pour faciliter cette étape:
+
+::
+
+    $ ./autogen.sh
+    + aclocal --force
+    + libtoolize --force --automake --copy
+    + automake --foreign --add-missing --force-missing --copy
+    + autoconf --force
+
+Cela **Makefile.in** fichiers et les scripts de **configuration**.
+
+**configure** script prend les options utiles suivantes:
+
+    --prefix=PREFIX         installe l'architecture-independent de PREFIX
+                            [/usr/local]
+    --enable-debug          enable debugging [default is yes]
+
+Le répertoire ** PREFIX ** sera utilisé par ** make install **. Son utilisation est obligatoire, sauf si
+la construction d'un paquet et l'installation dans les répertoires système.
+
+libarmadito utilise le **pkg-config** pour spécifier les options de compilation relatives à
+libarmadito. Depuis **libarmadito.pc** fichier de spécification pour **pkg-config** n'est pas situé
+dans le repertoire standard (habituel **/usr/lib/pkgconfig**), appel du script configure 
+doit utiliser le **PKG_CONFIG_PATH** environnement variable.
+
+Bâtir dans un répertoire distinct est fortement recommandé, sauf si vous voulez vraiment
+à clobber le sourcetree avec des objets, des bibliothèques, des binaires et d'autres choses.
+
+::
+
+    $ mkdir /home/joebar/build/modules/clamav
+
+L'appel typique du script de configuration est:
+
+::
+
+    $ /home/joebar/armadito-av/modules/clamav/configure --prefix=/home/joebar/install --enable-debug PKG_CONFIG_PATH=/home/joebar/install/lib/pkgconfig
+
+Notez que le chemin spécifié dans la valeur de**PKG_CONFIG_PATH** doit être cohérent
+avec le **PREFIX** utilisé dans l'installation libarmadito (voir **Armadito core** section de construction linux).
+
+
+Bâtiment
+--------
+
+Une fois configuré, la construction est facile:
+
+::
+
+    $ make
+
+
+Installation
+----------
+
+Après la construction, l'installation se fait par:
+
+::
+
+    $ make install
+
+Cela installera les bibliothèques, les outils, les fichiers d'en-tête ... dans les sous-répertoires de la **PREFIX**
+défini au moment de la configuration. 
+
diff --git a/source/fr/compilation/linux/core.rst b/source/fr/compilation/linux/core.rst
@@ -0,0 +1,99 @@
+Armadito core
+=============
+
+**Armadito core** correspond à la librairie libarmadito. Les symboles exportés depuis cette bibliothèque permettent à toutes les bibliothèques de modules d'utiliser les mêmes API.
+
+Les sources sont accessibles au public sur github.com, vous pouvez l'obtenir avec la commande suivante:
+
+::
+
+   $ git clone https://github.com/armadito/armadito-av.git -b DEV
+
+Les prérequis
+-------------
+
+Pour construire libarmadito, vous avez besoin des outils suivants:
+
+- automake / autoconf
+- Fabrication GNU
+- Compilateur C
+- glib, libmagic, libxml2, libmicrohttpd, bibliothèques libcurl et en-têtes
+
+Pour installer les en-têtes nécessaires:
+
+- Ubuntu:
+
+::
+
+     apt-get install automake autoconf libtool libglib2.0-dev libmagic-dev libxml2-dev libjson-c-dev libmicrohttpd-dev libcurl4-openssl-dev
+
+- Fedora:
+
+::
+
+     dnf install automake autoconf libtool glib2-devel file-devel libxml2-devel json-c-devel libmicrohttpd-devel libcurl-devel
+
+
+Configuration
+-------------
+
+Une fois git repo cloné, vous devez initialiser la construction en utilisant automake, autoconf et des outils.
+Un script shell **autogen.sh** est prévu pour faciliter cette étape :
+
+::
+
+    $ ./autogen.sh
+    + aclocal --force
+    + libtoolize --force --automake --copy
+    + autoheader --force
+    + automake --foreign --add-missing --force-missing --copy
+    + autoconf --force
+
+Cela **Makefile.in** fichiers et les **configure** script.
+
+**configure** script prend les options utiles suivantes:
+
+    --prefix=PREFIX         install architecture-independent files in PREFIX [default is /usr/local]
+    --enable-debug          enable debugging [default is yes]
+
+Le répertoire ** PREFIX ** sera utilisé par ** make install **. Son utilisation est obligatoire, sauf si
+La construction d'un paquetage et l'installation dans les répertoires système,
+Les modules de balayage et l'interface utilisateur graphique aura besoin d'un libarmadito correctement
+Installé.
+
+Bâtir dans un répertoire distinct est fortement recommandé, sauf si vous voulez vraiment
+Pour gifler l'arbre source avec des objets, des bibliothèques, des binaires et d'autres choses.
+
+::
+
+    $ mkdir /home/joebar/build/libarmadito
+
+L'appel typique du script de configuration est:
+
+::
+
+    $ /home/joebar/armadito-av/libarmadito/configure --prefix=/home/joebar/install --enable-debug
+
+
+Construction
+------------
+
+Une fois configuré, la construction est facile:
+
+::
+
+    $ make
+
+Installation
+------------
+
+Après la construction, l'installation se fait par:
+
+::
+
+    $ make install
+
+Cela installera les bibliothèques, les outils, les fichiers d'en-tête ... dans les sous-répertoires du ** PREFIX **
+Répertoire défini au moment de la configuration.
+
+.. toctree::