Added documentation for the plugin

README.rst

@@ -1,6 +1,21 @@
 Arethusa for CapiTainS Nemo
 ===========================
 
+.. image:: http://nemo-arethusa-plugin.readthedocs.io/badge/?version=latest
+    :alt: Documentation
+    :target: http://nemo-arethusa-plugin.readthedocs.io/
+
+.. image:: https://travis-ci.org/alpheios/nemo-arethusa-plugin.svg
+    :alt: Build status
+    :target: https://travis-ci.org/alpheios/nemo-arethusa-plugin
+
+.. image:: https://coveralls.io/repos/alpheios/nemo-arethusa-plugin/badge.svg?branch=master&service=github
+    :alt: Coverage
+    :target: https://coveralls.io/github/alpheios/nemo-arethusa-plugin?branch=master
+
+.. image:: https://badge.fury.io/py/nemo_arethusa_plugin.svg
+    :target: https://badge.fury.io/py/nemo_arethusa_plugin
+
 This repository contains a plugin for embedding Arethusa in `Flask Capitains Nemo <https://github.com/capitains/flask-capitains-nemo>`_. It was produced during the Perseids Tufts Hackathon in May 2016.
 
 Contributors

docs/Arethusa.api.rst

@@ -2,4 +2,7 @@ Arethusa for Nemo API
 =====================
 
 .. autoclass:: nemo_arethusa_plugin.Arethusa
-.. automethod:: nemo_arethusa_plugin.Arethusa.render
+.. automethod:: nemo_arethusa_plugin.Arethusa.render
+.. automethod:: nemo_arethusa_plugin.Arethusa.r_arethusa_assets
+.. automethod:: nemo_arethusa_plugin.Arethusa.r_arethusa_dependencies
+.. automethod:: nemo_arethusa_plugin.Arethusa.r_arethusa_config

docs/Arethusa.template.rst

@@ -0,0 +1,20 @@
+Text Template and It's Macro
+============================
+
+The :code:`arethusa::text.html` contains few macro to ensure reusability of the concept by other resources :
+
+tb_macro()
+##########
+
+Contains the container for the Arethusa Widget
+
+tabs(text, treebank)
+####################
+
+Creates a Bootstrap tab interface where the first tab is the text, the second would be the treebank
+
+Blocks and extensions
+#####################
+
+- The template extends main::container.html and feeds blocks additinalscript and article.
+- It imports from :code:`main::text.html` : :code:`show_passage`, :code:`header_passage`, :code:`default_footer`, and :code:`nav`

docs/index.rst

@@ -8,7 +8,10 @@ Arethusa for Nemo Plugin
 
 .. include:: ../README.rst
 
+Index :
+
 .. toctree::
    :maxdepth: 2
 
    Arethusa.api
+   Arethusa.template