Skip to content

Commit

Permalink
documentation fix (forgot templates) + added readthedocs badge to rea…
Browse files Browse the repository at this point in the history
…dme + updated doc link in readme
  • Loading branch information
proycon committed Aug 6, 2016
1 parent ec1f00e commit c453a4e
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ PyNLPl - Python Natural Language Processing Library
.. image:: http://applejack.science.ru.nl/lamabadge.php/pynlpl
:target: http://applejack.science.ru.nl/languagemachines/

.. image:: http://readthedocs.org/projects/pynlpl/badge/?version=latest
:target: http://pynlpl.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

PyNLPl, pronounced as 'pineapple', is a Python library for Natural Language
Processing. It contains various modules useful for common, and less common, NLP
tasks. PyNLPl can be used for basic tasks such as the extraction of n-grams and
Expand Down Expand Up @@ -48,6 +52,6 @@ The following modules are available:
- ``pynlpl.textprocessors`` - Simple tokeniser, n-gram extraction


API Documentation can be found `here <http://pythonhosted.org/PyNLPl/>`__.
API Documentation can be found `here <http://pynlpl.readthedocs.io/en/latest/>`__.


46 changes: 46 additions & 0 deletions docs/_templates/foliaelement.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{{ fullname }}
{{ underline }}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
:show-inheritance:
:undoc-members:
:special-members:

{% block methods %}

{% if methods %}
.. rubric:: Method Summary

.. autosummary::
{% for item in methods %}
~{{ name }}.{{ item }}
{%- endfor %}
~{{ name }}.__iter__
~{{ name }}.__len__
~{{ name }}.__str__
{% endif %}
{% endblock %}

{% block attributes %}
{% if attributes %}
.. rubric:: Class Attributes

{% for item in attributes %}
.. autoattribute:: {{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

.. rubric:: Method Details

{% for m in methods %}
.. automethod:: {{ m }}
{% endfor %}
.. automethod:: __iter__
.. automethod:: __len__
.. automethod:: __str__



42 changes: 42 additions & 0 deletions docs/_templates/fullclass.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{{ fullname }}
{{ underline }}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
:show-inheritance:
:members: *

{% block methods %}

{% if methods %}
.. rubric:: Method Summary

.. autosummary::
{% for item in methods %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

{% block attributes %}
{% if attributes %}
.. rubric:: Attributes

.. autosummary::
{% for item in attributes %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}

.. rubric:: Method Details

.. automethod:: __init__

{% for m in methods %}
.. automethod:: {{ m }}
{% endfor %}



0 comments on commit c453a4e

Please sign in to comment.