Add more docs

[skip ci]

docs/source/convert.rst

@@ -0,0 +1,4 @@
+Handling BEL
+============
+.. autofunction:: biokeen.convert.to_pykeen_path
+.. autofunction:: biokeen.convert.to_pykeen_df

docs/source/index.rst

@@ -14,7 +14,6 @@ by using its interactive command line interface that can be started with the com
 Installation is as easy as getting the code from `PyPI <https://pypi.python.org/pypi/biokeen>`_ with
 :code:`python3 -m pip install biokeen`.
 
-
 Citation
 --------
 If you use BioKEEN in your work, please cite [1]_:
@@ -46,6 +45,14 @@ If you use BioKEEN in your work, please cite [1]_:
    train_and_evaluate
    hyper_parameter_optimization
 
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Reference
+   :name: reference
+
+   convert
+
 .. toctree::
    :maxdepth: 2
    :caption: Biological Databases

src/biokeen/__init__.py

@@ -1,3 +1,5 @@
 # -*- coding: utf-8 -*-
 
 """BioKEEN."""
+
+from . import convert

src/biokeen/convert/io.py

@@ -32,7 +32,15 @@
 
 
 def to_pykeen_path(df: pd.DataFrame, path: str) -> bool:
-    """Write the relationships in the BEL graph to a KEEN TSV file."""
+    """Write the relationships in the BEL graph to a KEEN TSV file.
+
+    If you have a BEL graph, first do:
+
+    >>> from biokeen.convert import to_pykeen_df, to_pykeen_path
+    >>> graph = ...  # Something from PyBEL
+    >>> df = to_pykeen_df(graph)
+    >>> to_pykeen_path(df, 'graph.keen.tsv')
+    """
     if len(df.index) == 0:
         return False
     df.to_csv(path, sep='\t', index=None, header=None)