Fix docs

open-contracting · Mar 17, 2020 · ed759c9 · ed759c9
1 parent 895a54b
commit ed759c9
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 9 deletions.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,8 @@
+API
+=======
+
+.. toctree::
+
+   testing/index
+   schema
+   exceptions
diff --git a/docs/api/testing/schema.rst → docs/api/schema.rst b/docs/api/testing/schema.rst → docs/api/schema.rst
@@ -1,6 +1,6 @@
 Schema
 ======
 
-.. automodule:: jscc.testing.schema
+.. automodule:: jscc.schema
    :members:
    :undoc-members:
diff --git a/docs/api/testing/index.rst b/docs/api/testing/index.rst
@@ -4,6 +4,5 @@ Testing
 .. toctree::
 
    checks
-   schema
    filesystem
    util
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -13,7 +13,7 @@ Added
 Changed
 ~~~~~~~
 
--  ``jscc.testing.schema`` is moved to :module:`jscc.schema`
+-  ``jscc.testing.schema`` is moved to :mod:`jscc.schema`
 -  ``jscc.schema.is_property_missing`` is renamed to :meth:`jscc.schema.is_missing_property`
 -  :meth:`jscc.schema.is_codelist` accepts a list of field names, instead of a CSV reader
 -  :meth:`jscc.filesystem.walk_csv_data` returns text content, fieldnames, and rows, instead of a CSV reader

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,13 +3,10 @@ JSON Schema and CSV Codelists (JSCC)
 
 .. include:: ../README.rst
 
-API
----
-
 .. toctree::
+   :caption: Contents
 
-   api/testing/index
-   api/exceptions
+   api/index
    changelog
 
 Copyright (c) 2020 Open Contracting Partnership, released under the BSD license
diff --git a/jscc/schema.py b/jscc/schema.py
@@ -1,5 +1,5 @@
 """
-Methods for reasoning about JSON Schema and CSV codelists.
+Methods for interacting with or reasoning about JSON Schema and CSV codelists.
 """
 from collections import UserDict
 from copy import deepcopy