aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/developer
diff options
context:
space:
mode:
authorJeremy Benoist <j0k3r@users.noreply.github.com>2016-05-07 11:10:21 +0200
committerJeremy Benoist <j0k3r@users.noreply.github.com>2016-05-07 11:10:21 +0200
commit1556c925a42619c1298edebb73eb86c009b3f3c8 (patch)
tree2e893a9ed9ab1fb28db290d3643d7945e0ad611b /docs/en/developer
parentf54de6817ea320e6d92bea368123b2fb1395d95f (diff)
parente0f4f25fd6fba6f41532e9bf5cb6fa4c515c7a46 (diff)
downloadwallabag-1556c925a42619c1298edebb73eb86c009b3f3c8.tar.gz
wallabag-1556c925a42619c1298edebb73eb86c009b3f3c8.tar.zst
wallabag-1556c925a42619c1298edebb73eb86c009b3f3c8.zip
Merge pull request #2016 from wallabag/update-documentation
Update documentation
Diffstat (limited to 'docs/en/developer')
-rw-r--r--docs/en/developer/api.rst4
-rw-r--r--docs/en/developer/documentation.rst12
2 files changed, 15 insertions, 1 deletions
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst
index 3de8ba05..9594f9af 100644
--- a/docs/en/developer/api.rst
+++ b/docs/en/developer/api.rst
@@ -261,6 +261,8 @@ Have a look on the listing here: http://localhost:8000/api/doc to know each meth
261Third resources 261Third resources
262--------------- 262---------------
263 263
264Some applications use our API. Here is a non-exhaustive list of them: 264Some applications or libraries use our API. Here is a non-exhaustive list of them:
265 265
266- `Java wrapper for the wallabag API <https://github.com/Strubbl/wallabag-java>`_ by Strubbl.
267- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster.
266- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_. 268- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_.
diff --git a/docs/en/developer/documentation.rst b/docs/en/developer/documentation.rst
new file mode 100644
index 00000000..ab206479
--- /dev/null
+++ b/docs/en/developer/documentation.rst
@@ -0,0 +1,12 @@
1Contribute to this documentation
2================================
3
4Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs
5
6We use `ReadTheDocs
7<https://readthedocs.org>`__ to generate it.
8
9Pages are written in `Restructured Text
10<https://en.wikipedia.org/wiki/ReStructuredText>`__ format. You can use online tools like http://rst.aaroniles.net/ or http://rst.ninjs.org/ to preview your articles.
11
12If you create a new page, don't forget to edit the `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/index.rst>`__ file to add a link in the sidebar. \ No newline at end of file