Merge pull request #116 from ihmeuw/develop

Release v0.6.1

Author: rmudambi

CHANGELOG.rst

@@ -1,3 +1,8 @@
+**0.6.1 - 04/21/23**
+ - Updated documentation
+ - Standardized configuration key names
+ - Updated to account for changes to input data schema
+
 **0.6.0 - 04/19/23**
  - Update documentation (landing page, datasets section, quickstart)
  - Update zipcode miswriting function to act on each digit independently

docs/Pseudopeople-logo_FINAL_2023.04.11_psdppl-logo_blue-ombre.png

@@ -6,3 +6,7 @@ py:class pandas._libs.tslibs.timedeltas.Timedelta
 py:class pandas.core.frame.DataFrame
 py:class pandas.core.series.Series
 py:class pandas.core.generic.PandasObject
+
+# pseudopeople
+py:exc ConfigurationError
+py:exc DataSourceError

docs/nitpick-exceptions

@@ -0,0 +1,5 @@
+
+.. automodule:: pseudopeople.configuration.interface
+
+.. toctree::
+   :maxdepth: 2

docs/source/api_reference/configuration.rst

@@ -1,10 +1,14 @@
 API Reference
 =============
 
+There are two types of functions useful when working with the pseudopeople
+package: dataset generator functions and the config generator function.
+
+
 .. automodule:: pseudopeople
 
 .. toctree::
    :maxdepth: 2
    :glob:
 
-   *
+   */index

docs/source/api_reference/configuration/index.rst

@@ -0,0 +1,5 @@
+
+.. automodule:: pseudopeople.interface
+
+.. toctree::
+   :maxdepth: 2

docs/source/api_reference/index.rst

@@ -99,6 +99,7 @@
 
 
 # -- Options for HTML output ----------------------------------------------
+add_module_names = False
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.

docs/source/api_reference/interface.rst

@@ -0,0 +1,5 @@
+.. _configuration_main:
+
+=============
+Configuration
+=============