Skip to content

Commit

Permalink
fix rendering docs and broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
J535D165 committed Dec 22, 2017
1 parent 9e211eb commit e5cf451
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
5 changes: 4 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
'sklearn.utils',
'sklearn.utils.validation',
'sklearn.preprocessing',
'sklearn.externals',
'sklearn.externals.joblib',
'jellyfish',
'six'
]
Expand All @@ -59,7 +61,8 @@
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.napoleon',
'nbsphinx'
'nbsphinx',
'IPython.sphinxext.ipython_console_highlighting'
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
4 changes: 2 additions & 2 deletions docs/notebooks/custom_algorithms.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"For run the examples below, import *pandas*, *recordlinkage* and the two datasets belonging to sample dataset [FEBRL4](../reference.html#recordlinkage.datasets.load_febrl4). "
"For run the examples below, import *pandas*, *recordlinkage* and the two datasets belonging to sample dataset [FEBRL4](../ref-datasets.html#recordlinkage.datasets.load_febrl4). "
]
},
{
Expand Down Expand Up @@ -309,7 +309,7 @@
"metadata": {},
"source": [
"## Custom index algorithms\n",
"The Python Record Linkage Toolkit contains multiple algorithms to pair records (index algorithms) such as [full indexing](../reference.html#recordlinkage.indexing.FullIndex), [blocking](../reference.html#recordlinkage.indexing.BlockIndex) and [sorted neighbourhood indexing](../reference.html#recordlinkage.indexing.SortedNeighbourhoodIndex). This section explains how to make and implement a custom algorithm to make record pairs. \n",
"The Python Record Linkage Toolkit contains multiple algorithms to pair records (index algorithms) such as [full indexing](../ref-index.html#recordlinkage.indexing.FullIndex), [blocking](../ref-index.html#recordlinkage.indexing.BlockIndex) and [sorted neighbourhood indexing](../ref-index.html#recordlinkage.indexing.SortedNeighbourhoodIndex). This section explains how to make and implement a custom algorithm to make record pairs. \n",
"\n",
"To create a custom algorithm, you have to make a subclass of the ``recordlinkage.base.BaseIndexator``. In your subclass, you overwrite the ``_link_index`` method. This method accepts two pandas DataFrames as arguments. Based on these DataFrames, your method must create pairs and return them as a ``pandas.MultiIndex`` in which the MultiIndex names are the index names of DataFrame A and DataFrame B respectively. \n",
"\n",
Expand Down

0 comments on commit e5cf451

Please sign in to comment.