update docs with new modules

mscarey · Aug 9, 2019 · 1beffa4 · 1beffa4
1 parent b140b84
commit 1beffa4
Show file tree

Hide file tree

Showing 11 changed files with 61 additions and 12 deletions.
diff --git a/authorityspoke/io/references.py b/authorityspoke/io/references.py
@@ -1,3 +1,5 @@
+r"""Resolving references in imported data to :class:`.Factor`\s and text passages."""
+
 import functools
 
 from typing import Callable, Dict, Iterable, List, Optional, Tuple, Union

diff --git a/docs/api/analogies.rst b/docs/api/analogies.rst
@@ -0,0 +1,7 @@
+``Analogies``
+================
+
+.. autoclass:: authorityspoke.relations.Analogy
+    :members:
+
+.. autofunction:: authorityspoke.relations.all_analogy_matches
diff --git a/docs/api/context.rst b/docs/api/context.rst
@@ -3,13 +3,3 @@
 ============================
 
 .. autodecorator:: authorityspoke.context.new_context_helper
-
-.. autodecorator:: authorityspoke.context.log_mentioned_context
-
-``Analogies``
-================
-
-.. autoclass:: authorityspoke.relations.Analogy
-    :members:
-
-.. autofunction:: authorityspoke.relations.all_analogy_matches
diff --git a/docs/api/legislation.rst b/docs/api/legislation.rst
@@ -9,8 +9,6 @@
     :members:
     :special-members:
 
-.. autofunction:: authorityspoke.context.get_directory_path
-
 ``Enactments``
 ==============
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -30,8 +30,24 @@ API Reference
     api/predicates
     api/legislation
     api/context
+    api/analogies
     api/selectors
 
+I/O
+-------------
+
+.. toctree::
+    :maxdepth: 2
+
+    io/downloads
+    io/loaders
+    io/readers
+    io/writers
+    io/filepaths
+    io/references
+
+
+
 Development Updates
 -------------------
 

diff --git a/docs/io/downloads.rst b/docs/io/downloads.rst
@@ -0,0 +1,6 @@
+==============
+``Downloads``
+==============
+
+.. automodule:: authorityspoke.io.downloads
+   :members:
diff --git a/docs/io/filepaths.rst b/docs/io/filepaths.rst
@@ -0,0 +1,6 @@
+==============
+``Filepaths``
+==============
+
+.. automodule:: authorityspoke.io.filepaths
+   :members:
diff --git a/docs/io/loaders.rst b/docs/io/loaders.rst
@@ -0,0 +1,6 @@
+==============
+``Loaders``
+==============
+
+.. automodule:: authorityspoke.io.loaders
+   :members:
diff --git a/docs/io/readers.rst b/docs/io/readers.rst
@@ -0,0 +1,6 @@
+==============
+``Readers``
+==============
+
+.. automodule:: authorityspoke.io.readers
+   :members:
diff --git a/docs/io/references.rst b/docs/io/references.rst
@@ -0,0 +1,6 @@
+==============
+``References``
+==============
+
+.. automodule:: authorityspoke.io.references
+   :members:
diff --git a/docs/io/writers.rst b/docs/io/writers.rst
@@ -0,0 +1,6 @@
+==============
+``Writers``
+==============
+
+.. automodule:: authorityspoke.io.writers
+   :members: