Merge pull request #141 from ihmeuw/develop

Release v0.6.3
ihmeuw · Apr 25, 2023 · 407e0c8 · 407e0c8
2 parents c3bf67b + f31344f
commit 407e0c8
Show file tree

Hide file tree

Showing 19 changed files with 325 additions and 178 deletions.
diff --git a/.github/ISSUE_TEMPLATE/data_access_request.yml b/.github/ISSUE_TEMPLATE/data_access_request.yml
@@ -0,0 +1,44 @@
+name: Data access request
+description: Request access to pseudopeople input data (beyond the sample included with pseudopeople)
+body:
+  - type: input
+    attributes:
+      label: "What is the name of your project?"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "What is the purpose of your project?"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Who is involved in the project? Which of these people will have direct access to the pseudopeople input data?"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "What funding is the project under? What expectations with respect to open access and access to data come with that funding?"
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: "We commit to:"
+      options:
+        - label: be responsive to further questions from interested parties
+          required: true
+        - label: deprecate and replace our version of the pseudopeople input data when a new version is released
+          required: true
+  - type: checkboxes
+    attributes:
+      label: What data would you like to request?
+      options:
+        - label: Full US
+        - label: Rhode Island
+        - label: Other (may not be available immediately)
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Other data - more explanation
+      description: If you selected "Other" on the previous question, please provide more details about the input data you would like.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,7 @@
+**0.6.3 - 04/24/23**
+ - Updated documentation
+ - Added data access request to issue template
+
 **0.6.2 - 04/21/23**
  - Updated documentation
  - Updated progress bar behavior

diff --git a/docs/Pseudopeople-logo_FINAL_2023.04.11_psdppl-logo_blue-ombre.png b/docs/Pseudopeople-logo_FINAL_2023.04.11_psdppl-logo_blue-ombre.png
diff --git a/docs/source/_static/pseudopeople_logo_white.png b/docs/source/_static/pseudopeople_logo_white.png
diff --git a/docs/source/api_reference/configuration/index.rst b/docs/source/api_reference/configuration/index.rst
@@ -1,5 +1,10 @@
 
+.. Display the module's docstring (not at top level of pseudopeople)
+
 .. automodule:: pseudopeople.configuration.interface
+   :no-members:
+
+.. autofunction:: pseudopeople.get_config
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/api_reference/index.rst b/docs/source/api_reference/index.rst
@@ -5,8 +5,6 @@ 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:

diff --git a/docs/source/api_reference/noising/index.rst b/docs/source/api_reference/noising/index.rst
@@ -1,5 +1,11 @@
+.. Display the module's docstring (not at top level of pseudopeople)
 
 .. automodule:: pseudopeople.interface
+   :no-members:
+
+.. automodule:: pseudopeople
+   :imported-members:
+   :exclude-members: get_config
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/concepts/configuration.rst b/docs/source/concepts/configuration.rst
diff --git a/docs/source/concepts/datasets.rst b/docs/source/concepts/datasets.rst
diff --git a/docs/source/concepts/index.rst b/docs/source/concepts/index.rst
diff --git a/docs/source/concepts/noise_functions.rst b/docs/source/concepts/noise_functions.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -99,13 +99,16 @@
 
 
 # -- 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.
 
 html_theme_path = ["_theme"]
 html_theme = "sphinx_rtd_theme"
+html_logo = "_static/pseudopeople_logo_white.png"
+html_theme_options = {
+    "logo_only": True,
+}
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the