wallabag/docs/en/index.rst

wallabag documentation
======================

.. image:: ../img/wallabag.png
   :alt: wallabag logo
   :align: center

**wallabag** is a read-it-later application: it saves a web page by
keeping content only. Elements like navigation or ads are deleted.

.. tip::

    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>`__.

The main documentation for this application is organized into a couple sections:

* :ref:`user-docs`
* :ref:`dev-docs`

The documentation is available in other languages:

* `Documentation en français <http://doc.wallabag.org/fr/master/>`_
* `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_

.. _user-docs:

.. toctree::
   :maxdepth: 2
   :caption: User documentation

   user/faq
   user/installation
   user/upgrade-2.0.x-2.1.1
   user/upgrade-2.1.x-2.1.y
   user/migration
   user/import
   user/create_account
   user/login
   user/configuration
   user/first_article
   user/errors_during_fetching
   user/annotations
   user/download_articles
   user/share
   user/filters
   user/tags
   user/android

.. _dev-docs:

.. toctree::
   :maxdepth: 2
   :caption: Developer documentation

   developer/api
   developer/docker
   developer/documentation
   developer/translate
   developer/maintenance
   developer/redis
   developer/rabbitmq
add docs 2015-10-21 12:14:51 +00:00			`wallabag documentation`
			`======================`

			`.. image:: ../img/wallabag.png`
			`:alt: wallabag logo`
			`:align: center`

			`wallabag is a read-it-later application: it saves a web page by`
			`keeping content only. Elements like navigation or ads are deleted.`

Update documentation 2016-05-03 13:50:13 +00:00			`.. tip::`
French translation for documentation 2016-02-20 07:39:08 +00:00
			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>`__.

documentation cleaning 2016-01-08 14:02:51 +00:00			`The main documentation for this application is organized into a couple sections:`
add docs 2015-10-21 12:14:51 +00:00
			* :ref:`user-docs`
Quickstart for beginners 2016-01-09 13:34:49 +00:00			* :ref:`dev-docs`
add docs 2015-10-21 12:14:51 +00:00
Add links to translations in documentation homepage 2016-09-15 12:58:14 +00:00			`The documentation is available in other languages:`

			* `Documentation en français <http://doc.wallabag.org/fr/master/>`_
			* `Deutsch Dokumentation <http://doc.wallabag.org/de/master/>`_

add docs 2015-10-21 12:14:51 +00:00			`.. _user-docs:`

			`.. toctree::`
			`:maxdepth: 2`
Quickstart for beginners 2016-01-09 13:34:49 +00:00			`:caption: User documentation`
add docs 2015-10-21 12:14:51 +00:00
Add FAQ page in documentation 2016-04-23 08:36:25 +00:00			`user/faq`
Documentation for wallabag installation 2016-02-21 12:55:10 +00:00			`user/installation`
Fix links on english documentation homepage 2016-10-11 12:59:32 +00:00			`user/upgrade-2.0.x-2.1.1`
			`user/upgrade-2.1.x-2.1.y`
Update documentation 2016-05-03 13:50:13 +00:00			`user/migration`
Move some parts in FAQ 2016-05-03 18:51:23 +00:00			`user/import`
add docs 2015-10-21 12:14:51 +00:00			`user/create_account`
			`user/login`
			`user/configuration`
			`user/first_article`
Added documentation about errors during fetching 2016-02-22 21:00:52 +00:00			`user/errors_during_fetching`
Add annotator in baggy theme + Documentation about annotations 2016-02-23 10:32:48 +00:00			`user/annotations`
documentation cleaning 2016-01-08 14:02:51 +00:00			`user/download_articles`
Add documentation about article sharing 2016-08-25 13:28:46 +00:00			`user/share`
documentation cleaning 2016-01-08 14:02:51 +00:00			`user/filters`
Quickstart for beginners 2016-01-09 13:34:49 +00:00			`user/tags`
add first draft of Android app documentation 2016-05-04 21:25:49 +00:00			`user/android`
Quickstart for beginners 2016-01-09 13:34:49 +00:00
			`.. _dev-docs:`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Developer documentation`

Documentation about wallabag API 2016-04-06 09:30:41 +00:00			`developer/api`
Documentation about translation 2016-02-17 13:39:30 +00:00			`developer/docker`
Add documentation to know how to contribute to the documentation :trollface: 2016-05-04 12:42:14 +00:00			`developer/documentation`
Documentation about translation 2016-02-17 13:39:30 +00:00			`developer/translate`
documentation for maintenance mode 2016-02-22 11:49:49 +00:00			`developer/maintenance`
Added links to async config in english doc 2016-09-28 14:37:02 +00:00			`developer/redis`
			`developer/rabbitmq`