docs: api reference

docs/api/entity.rst

@@ -0,0 +1,4 @@
+Entity
+------
+
+.. autoclass:: nyoibo.entities.Entity

docs/api/fields.rst

@@ -0,0 +1,58 @@
+.. _fields:
+
+Fields
+======
+
+Base Field
+----------
+
+.. autoclass:: nyoibo.fields.Field
+   :members:
+
+String Field
+------------
+
+.. autoclass:: nyoibo.fields.StrField
+   :members:
+
+Integer Field
+-------------
+
+.. autoclass:: nyoibo.fields.IntField
+   :members:
+
+Boolean Field
+-------------
+
+.. autoclass:: nyoibo.fields.BoolField
+   :members:
+
+Date Field
+----------
+
+.. autoclass:: nyoibo.fields.DateField
+   :members:
+
+Datetime Field
+--------------
+
+.. autoclass:: nyoibo.fields.DatetimeField
+   :members:
+
+Float Field
+-----------
+
+.. autoclass:: nyoibo.fields.FloatField
+   :members:
+
+Decimal Field
+-------------
+
+.. autoclass:: nyoibo.fields.DecimalField
+   :members:
+
+Link Field
+----------
+
+.. autoclass:: nyoibo.fields.LinkField
+   :members:

docs/api/index.rst

@@ -0,0 +1,8 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   entity.rst
+   fields.rst

docs/index.rst

@@ -13,3 +13,4 @@ Contents
    :maxdepth: 2
 
    usage
+   api/index

docs/usage.rst

@@ -142,7 +142,7 @@ setter in ``get_{field_name}`` or ``set_{field_name}`` way. Example:
 Fields
 ------
 
-Nyoibo has several fields type (you can check all types in API reference).
+Nyoibo has several fields type (you can check all types in :ref:`fields`).
 Each field has an internal Python type and it will try to parse and cast to
 this Python type. So ``StrField`` will cast to ``str``, ``IntField`` will cast
 to ``int``, ``FloatField`` to ``float`` and so on. Let's see an example:

nyoibo/entities/entity.pyx

@@ -3,6 +3,20 @@ from .meta_entity import MetaEntity
 
 
 class Entity(metaclass=MetaEntity):
+    """Entity.
+
+    This class must be superclass for classes that you want create getters or
+    setters.
+    All fields must starts with ``_``.
+
+    Args:
+        kwargs: values to fields.
+
+    Raises:
+        FieldValueError: if the casting failed.
+        PrivateFieldError: if a field does not start with ``_``.
+            This exception is raised when program starts.
+    """
 
     def __init__(self, **kwargs):
         cdef str key

nyoibo/entities/meta_entity.py

@@ -1,6 +1,6 @@
 from typing import Dict, Any
 
-from nyoibo.exceptions import PrivateField
+from nyoibo.exceptions import PrivateFieldError
 from nyoibo.fields import Field
 
 
@@ -25,7 +25,7 @@ def __new__(mcs, name, bases, namespace: Dict[str, Any]):
         for attr, value in namespace.items():
             if isinstance(value, Field):
                 if not attr.startswith('_'):
-                    raise PrivateField('Fields must be private')
+                    raise PrivateFieldError('Fields must be private')
 
                 fields[attr] = value
                 MetaEntity._set_getters_and_setters(

nyoibo/exceptions.py

@@ -3,7 +3,7 @@ class NyoiboError(Exception):
     pass
 
 
-class PrivateField(NyoiboError):
+class PrivateFieldError(NyoiboError):
     pass