Merge pull request #273 from mdekstrand/fix/271-duplicate-references

Use BibTeX for references
lenskit · Oct 19, 2021 · 8e47505 · 8e47505
2 parents a311984 + e5e054b
commit 8e47505
Show file tree

Hide file tree

Showing 11 changed files with 382 additions and 53 deletions.
diff --git a/doc/algorithms.rst b/doc/algorithms.rst
@@ -5,7 +5,7 @@ Algorithm Summary
 
 LKPY provides general algorithmic concepts, along with implementations of several
 algorithms.  These algorithm interfaces are based on the SciKit design patterns
-[SKAPI]_, adapted for Pandas-based data structures.
+:cite:p:`Buitinck2013-ks`, adapted for Pandas-based data structures.
 
 
 All algorithms implement the `standard interfaces`_.
@@ -58,12 +58,3 @@ External Library Wrappers
     implicit.BPR
     implicit.ALS
     hpf.HPF
-
-References
-~~~~~~~~~~
-
-.. [SKAPI] Lars Buitinck, Gilles Louppe, Mathieu Blondel, Fabian Pedregosa, Andreas Mueller,
-    Olivier Grisel, Vlad Niculae, Peter Prettenhofer, Alexandre Gramfort, Jaques Grobler,
-    Robert Layton, Jake Vanderplas, Arnaud Joly, Brian Holt, and Gaël Varoquaux. 2013.
-    API design for machine learning software: experiences from the scikit-learn project.
-    arXiv:`1309.0238 <http://arxiv.org/abs/1309.0238>`_ [cs.LG].
diff --git a/doc/conf.py b/doc/conf.py
@@ -48,7 +48,8 @@
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
-    'sphinx_rtd_theme'
+    'sphinxcontrib.bibtex',
+    'sphinx_rtd_theme',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -201,6 +202,8 @@
     'show-inheritance': True
 }
 
+bibtex_bibfiles = ['lenskit.bib']
+
 # -- Module Canonicalization ------------------------------------------------
 
 cleanups = {

diff --git a/doc/datasets.rst b/doc/datasets.rst
@@ -61,7 +61,8 @@ MovieLens Data Sets
 -------------------
 
 The GroupLens research group provides several data sets extracted from the
-MovieLens service [HK2015]_.  These can be downloaded from https://grouplens.org/datasets/movielens/.
+MovieLens service :cite:p:`Harper2015-cx`.
+These can be downloaded from https://grouplens.org/datasets/movielens/.
 
 .. autoclass:: MovieLens
     :members:
@@ -76,9 +77,3 @@ MovieLens service [HK2015]_.  These can be downloaded from https://grouplens.org
 .. autoclass:: ML10M
     :inherited-members:
     :members:
-
-
-.. [HK2015] F. Maxwell Harper and Joseph A. Konstan. 2015.
-   The MovieLens Datasets: History and Context.
-   *ACM Transactions on Interactive Intelligent Systems* (TiiS) **5**, 4, Article 19 (December 2015),
-   19 pages. DOI=http://dx.doi.org/10.1145/2827872
diff --git a/doc/hpf.rst b/doc/hpf.rst
@@ -4,13 +4,9 @@ Hierarchical Poisson Factorization
 .. module:: lenskit.algorithms.hpf
 
 This module provides a LensKit bridge to the hpfrec_ library implementing hierarchical Poisson
-factorization [GHB2013]_.
+factorization :cite:p:`Gopalan2013-ko`.
 
 .. _hpfrec: https://hpfrec.readthedocs.io/en/latest/
-.. [GHB2013] Prem Gopalan, Jake M. Hofman, and David M. Blei. 2013.
-    Scalable Recommendation with Poisson Factorization.
-    arXiv:1311.1704 [cs, stat] (November 2013). Retrieved February 9, 2017
-    from `<http://arxiv.org/abs/1311.1704>`_.
 
 .. autoclass:: HPF
     :members:
diff --git a/doc/index.rst b/doc/index.rst
@@ -71,6 +71,12 @@ Resources
     util
     internals
 
+.. toctree::
+    :maxdepth: 2
+    :caption: Links
+
+    references
+
 
 Indices and tables
 ==================