diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/de/conf.py | 55 | ||||
-rw-r--r-- | docs/de/requirements.txt | 2 | ||||
-rw-r--r-- | docs/de/user/errors_during_fetching.rst | 2 | ||||
-rw-r--r-- | docs/en/user/errors_during_fetching.rst | 2 | ||||
-rw-r--r-- | docs/en/user/import.rst | 21 | ||||
-rw-r--r-- | docs/fr/user/errors_during_fetching.rst | 2 | ||||
-rw-r--r-- | docs/fr/user/import.rst | 20 |
7 files changed, 92 insertions, 12 deletions
diff --git a/docs/de/conf.py b/docs/de/conf.py new file mode 100644 index 00000000..8f2d130d --- /dev/null +++ b/docs/de/conf.py | |||
@@ -0,0 +1,55 @@ | |||
1 | # -*- coding: utf-8 -*- | ||
2 | # | ||
3 | # wallabag documentation build configuration file, created by | ||
4 | # sphinx-quickstart on Fri Oct 16 06:47:23 2015. | ||
5 | |||
6 | import sys | ||
7 | import os | ||
8 | |||
9 | extensions = [] | ||
10 | templates_path = ['_templates'] | ||
11 | source_suffix = '.rst' | ||
12 | master_doc = 'index' | ||
13 | project = u'wallabag-fr' | ||
14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' | ||
15 | version = '2.0.0' | ||
16 | release = version | ||
17 | exclude_patterns = ['_build'] | ||
18 | pygments_style = 'sphinx' | ||
19 | html_theme = 'default' | ||
20 | html_static_path = ['_static'] | ||
21 | htmlhelp_basename = 'wallabagdedoc' | ||
22 | |||
23 | latex_elements = { | ||
24 | } | ||
25 | |||
26 | latex_documents = [ | ||
27 | ('index', 'wallabag-de.tex', u'wallabag Documentation', | ||
28 | u'Nicolas Lœuillet', 'manual'), | ||
29 | ] | ||
30 | |||
31 | man_pages = [ | ||
32 | ('index', 'wallabagde', u'wallabag Documentation', | ||
33 | [u'Nicolas Lœuillet'], 1) | ||
34 | ] | ||
35 | |||
36 | texinfo_documents = [ | ||
37 | ('index', 'wallabag', u'wallabag Documentation', | ||
38 | u'Nicolas Lœuillet', 'wallabag', 'wallabag is an opensource read-it-later.', | ||
39 | 'Miscellaneous'), | ||
40 | ] | ||
41 | |||
42 | ##### Guzzle sphinx theme | ||
43 | |||
44 | import guzzle_sphinx_theme | ||
45 | html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator' | ||
46 | html_theme_path = guzzle_sphinx_theme.html_theme_path() | ||
47 | html_theme = 'guzzle_sphinx_theme' | ||
48 | |||
49 | # Custom sidebar templates, maps document names to template names. | ||
50 | html_sidebars = { | ||
51 | '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html'] | ||
52 | } | ||
53 | |||
54 | # Register the theme as an extension to generate a sitemap.xml | ||
55 | extensions.append("guzzle_sphinx_theme") | ||
diff --git a/docs/de/requirements.txt b/docs/de/requirements.txt new file mode 100644 index 00000000..06fc8973 --- /dev/null +++ b/docs/de/requirements.txt | |||
@@ -0,0 +1,2 @@ | |||
1 | Sphinx>=1.3.0,<1.4.0 | ||
2 | guzzle_sphinx_theme>=0.7.0,<0.8.0 | ||
diff --git a/docs/de/user/errors_during_fetching.rst b/docs/de/user/errors_during_fetching.rst index b8e3e999..29621559 100644 --- a/docs/de/user/errors_during_fetching.rst +++ b/docs/de/user/errors_during_fetching.rst | |||
@@ -12,7 +12,7 @@ Das kann verschiedene Ursachen haben: | |||
12 | Wie kann ich helfen das zu beheben? | 12 | Wie kann ich helfen das zu beheben? |
13 | ----------------------------------- | 13 | ----------------------------------- |
14 | 14 | ||
15 | - `indem du uns eine Mail mit der URL des Artikels sendest <mailto:hello\@wallabag.org>`_ | 15 | - `indem du uns eine Mail mit der URL des Artikels sendest <mailto:hello@wallabag.org>`_ |
16 | - indem du versuchst das Laden des Artikels durch Erstellen einer Datei für den Artikel | 16 | - indem du versuchst das Laden des Artikels durch Erstellen einer Datei für den Artikel |
17 | selbst zu beheben | 17 | selbst zu beheben |
18 | Du kannst `dieses Tool <http://siteconfig.fivefilters.org/>`__ nutzen. | 18 | Du kannst `dieses Tool <http://siteconfig.fivefilters.org/>`__ nutzen. |
diff --git a/docs/en/user/errors_during_fetching.rst b/docs/en/user/errors_during_fetching.rst index da6ee745..68892750 100644 --- a/docs/en/user/errors_during_fetching.rst +++ b/docs/en/user/errors_during_fetching.rst | |||
@@ -12,7 +12,7 @@ There may be several reasons: | |||
12 | How can I help to fix that? | 12 | How can I help to fix that? |
13 | --------------------------- | 13 | --------------------------- |
14 | 14 | ||
15 | - `by sending us an email with the article's URL <mailto:hello\@wallabag.org>`_ | 15 | - `by sending us an email with the article's URL <mailto:hello@wallabag.org>`_ |
16 | - by trying to fix this article by yourself :) by creating a file for the article. | 16 | - by trying to fix this article by yourself :) by creating a file for the article. |
17 | You can use `this tool <http://siteconfig.fivefilters.org/>`__. | 17 | You can use `this tool <http://siteconfig.fivefilters.org/>`__. |
18 | 18 | ||
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 63210484..e6c37d72 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -30,14 +30,25 @@ You need to authorize wallabag to interact with your Pocket account. | |||
30 | Your data will be imported. Data import can be a demanding process for your server | 30 | Your data will be imported. Data import can be a demanding process for your server |
31 | (we need to work on this import to improve it). | 31 | (we need to work on this import to improve it). |
32 | 32 | ||
33 | From Instapaper | ||
34 | --------------- | ||
35 | |||
36 | *Feature not yet implemented in wallabag v2.* | ||
37 | |||
38 | From Readability | 33 | From Readability |
39 | ---------------- | 34 | ---------------- |
40 | 35 | ||
36 | Export your Readability data | ||
37 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
38 | |||
39 | On the tools (`https://www.readability.com/tools/<https://www.readability.com/tools/>`_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). | ||
40 | |||
41 | Import your data into wallabag 2.x | ||
42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
43 | |||
44 | Click on ``Import`` link in the menu, on ``Import contents`` in Readability section | ||
45 | and then select your json file and upload it. | ||
46 | |||
47 | Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). | ||
48 | |||
49 | From Instapaper | ||
50 | --------------- | ||
51 | |||
41 | *Feature not yet implemented in wallabag v2.* | 52 | *Feature not yet implemented in wallabag v2.* |
42 | 53 | ||
43 | From HTML or JSON file | 54 | From HTML or JSON file |
diff --git a/docs/fr/user/errors_during_fetching.rst b/docs/fr/user/errors_during_fetching.rst index 0f26fbc8..74290bef 100644 --- a/docs/fr/user/errors_during_fetching.rst +++ b/docs/fr/user/errors_during_fetching.rst | |||
@@ -12,7 +12,7 @@ Il peut y avoir plusieurs raisons : | |||
12 | Comment puis-je aider pour réparer ça ? | 12 | Comment puis-je aider pour réparer ça ? |
13 | --------------------------------------- | 13 | --------------------------------------- |
14 | 14 | ||
15 | - `en nous envoyant un email avec l'URL de l'article <mailto:hello\@wallabag.org>`_ | 15 | - `en nous envoyant un email avec l'URL de l'article <mailto:hello@wallabag.org>`_ |
16 | - en essayant de réparer cet article par vous-même :) en créant un fichier pour l'article. | 16 | - en essayant de réparer cet article par vous-même :) en créant un fichier pour l'article. |
17 | Vous pouvez utiliser `cet outil <http://siteconfig.fivefilters.org/>`__. | 17 | Vous pouvez utiliser `cet outil <http://siteconfig.fivefilters.org/>`__. |
18 | 18 | ||
diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index e6c2fa02..99ac602b 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst | |||
@@ -30,15 +30,27 @@ Vous devez autoriser wallabag à se connecter à votre compte Pocket. | |||
30 | Vos données vont être importées. L'import de données est une action qui peut être couteuse | 30 | Vos données vont être importées. L'import de données est une action qui peut être couteuse |
31 | pour votre serveur (nous devons encore travailler pour améliorer cet import). | 31 | pour votre serveur (nous devons encore travailler pour améliorer cet import). |
32 | 32 | ||
33 | Depuis Readability | ||
34 | ------------------ | ||
35 | |||
36 | Exportez vos données de Readability | ||
37 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
38 | |||
39 | Sur la page des outils (`https://www.readability.com/tools/<https://www.readability.com/tools/>`_), cliquez sur "Export your data" dans la section "Data Export". Vous allez recevoir un email avec un lien pour télécharger le json. | ||
40 | |||
41 | Importez vos données dans wallabag 2.x | ||
42 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
43 | |||
44 | Cliquez sur le lien ``Importer`` dans le menu, sur ``Importer les contenus`` dans | ||
45 | la section Readability et ensuite sélectionnez votre fichier json pour l'uploader. | ||
46 | |||
47 | Vos données vont être importées. L'import de données est une action qui peut être couteuse pour votre serveur (nous devons encore travailler pour améliorer cet import). | ||
48 | |||
33 | Depuis Instapaper | 49 | Depuis Instapaper |
34 | ----------------- | 50 | ----------------- |
35 | 51 | ||
36 | *Fonctionnalité pas encore implémentée dans wallabag v2.* | 52 | *Fonctionnalité pas encore implémentée dans wallabag v2.* |
37 | 53 | ||
38 | Depuis Readability | ||
39 | ------------------ | ||
40 | |||
41 | *Fonctionnalité pas encore implémentée dans wallabag v2.* | ||
42 | 54 | ||
43 | Depuis un fichier HTML ou JSON | 55 | Depuis un fichier HTML ou JSON |
44 | ------------------------------ | 56 | ------------------------------ |