docs/en/index.rst

   1 wallabag documentation
   2 ======================
   3
   4 .. image:: ../img/wallabag.png
   5    :alt: wallabag logo
   6    :align: center
   7
   8 **wallabag** is a read-it-later application: it saves a web page by
   9 keeping content only. Elements like navigation or ads are deleted.
  10
  11 .. tip::
  12
  13     This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__.
  14
  15 The main documentation for this application is organized into a couple sections:
  16
  17 * :ref:`user-docs`
  18 * :ref:`dev-docs`
  19
  20 The documentation is available in other languages:
  21
  22 * `Documentation en français <http://doc.wallabag.org/fr/master/>`_
  23 * `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_
  24
  25 .. _user-docs:
  26
  27 .. toctree::
  28    :maxdepth: 2
  29    :caption: User documentation
  30
  31    user/faq
  32    user/installation
  33    user/upgrade
  34    user/migration
  35    user/import
  36    user/create_account
  37    user/login
  38    user/configuration
  39    user/first_article
  40    user/errors_during_fetching
  41    user/annotations
  42    user/download_articles
  43    user/share
  44    user/filters
  45    user/tags
  46    user/android
  47
  48 .. _dev-docs:
  49
  50 .. toctree::
  51    :maxdepth: 2
  52    :caption: Developer documentation
  53
  54    developer/api
  55    developer/docker
  56    developer/documentation
  57    developer/translate
  58    developer/maintenance