Merge pull request #944 from NickCrews/docs-CI

Add Docs build to CI
dedupeio · Jan 27, 2022 · 4d4e9fb · 4d4e9fb
2 parents f349899 + ad1705c
commit 4d4e9fb
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/docs/API-documentation.rst b/docs/API-documentation.rst
@@ -136,6 +136,7 @@ Dedupe and StaticDedupe
 .. currentmodule:: dedupe
 
 .. class:: Dedupe
+   :noindex:
 
     .. attribute:: fingerprinter
 
@@ -147,6 +148,7 @@ Dedupe and StaticDedupe
     .. automethod:: cluster
 
 .. class:: StaticDedupe
+   :noindex:
 
     .. attribute:: fingerprinter
 
@@ -169,6 +171,7 @@ RecordLink and StaticRecordLink
 *******************************
 
 .. class:: RecordLink
+   :noindex:
 
     .. attribute:: fingerprinter
 
@@ -181,6 +184,7 @@ RecordLink and StaticRecordLink
     .. automethod:: many_to_one		    
 
 .. class:: StaticRecordLink
+   :noindex:
 
    .. attribute:: fingerprinter
 
@@ -207,6 +211,7 @@ Gazetteer and StaticGazetteer
 *****************************
 
 .. class:: Gazetteer
+   :noindex:
 
     .. attribute:: fingerprinter
 
@@ -218,6 +223,7 @@ Gazetteer and StaticGazetteer
     .. automethod:: many_to_n
 
 .. class:: StaticGazeteer
+   :noindex:
 
     .. attribute:: fingerprinter
 
@@ -240,8 +246,7 @@ Gazetteer and StaticGazetteer
 .. autoclass:: dedupe.blocking.Fingerprinter
 
    .. automethod:: __call__
-   .. autoinstanceattribute:: index_fields
-       :annotation:
+   .. autoattribute:: index_fields
    .. automethod:: index
    .. automethod:: unindex	       
    .. automethod:: reset_indices

diff --git a/docs/Makefile b/docs/Makefile
@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -W
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build

diff --git a/docs/Variable-definition.rst b/docs/Variable-definition.rst
@@ -42,7 +42,7 @@ ShortString Types
 ^^^^^^^^^^^^^^^^^
 
 A ``ShortString`` type field is just like ``String`` types except that dedupe
-will not try to learn an :ref:`index-block-label` rule for these fields, which can
+will not try to learn any :ref:`index blocking rules <index-blocks-label>` for these fields, which can
 speed up the training phase considerably.
 
 Zip codes and city names are good candidates for this type. If in doubt,