Merge pull request #203 from RacimoLab/prep

prepare for release

Author: mergify[bot]

CHANGELOG.md

@@ -1,7 +1,10 @@
 # Changelog
 
-## unreleased
+## 0.3.0 - 2022-08-08
 
+* Changed how the CLI is used. Now the model and discriminator
+  are specified with the -m/--model and -d/--discriminator
+  options, even when they are required.
 * Removed DinfModel.feature_shape.
 * Simplified Discriminator API.
 * Add progress bars and do logging with `rich`.

dinf/cli.py

@@ -693,7 +693,8 @@ def __init__(self, subparsers):
         self.add_argument_model(parser=group)
         self.add_argument_discriminator(parser=group)
         group.add_argument(
-            "output_file",
+            "-o",
+            "--output-file",
             metavar="output.npz",
             type=pathlib.Path,
             help="Output data, matching thetas to discriminator predictions.",

docs/_config.yml

@@ -18,10 +18,12 @@ repository:
   path_to_book: docs
   branch: main
 
-html:
-  use_issues_button: true
-  use_repository_button: true
-  use_edit_page_button: true
+## Jupyter-book uses this to set *some* sphinx config variables, but not all.
+## We use sphinx.config.html_theme_options instead.
+#html:
+#  use_issues_button: true
+#  use_repository_button: true
+#  use_edit_page_button: true
 
 sphinx:
   extra_extensions:
@@ -40,6 +42,18 @@ sphinx:
     intersphinx_aliases: _ext
 
   config:
+    # Jupyter-book also has a "html" top-level config property that can be
+    # used to set *some* sphinx config variables, but not all.
+    # Some documented variables will have no effect unless used inside
+    # sphinx.config.html_theme_options, so we just put everything here.
+    html_theme_options:
+        repository_url: https://github.com/RacimoLab/dinf
+        use_fullscreen_button: true
+        use_issues_button: true
+        use_repository_button: true
+        use_edit_page_button: false
+        use_download_button: false
+
     autodoc_typehints: description
     autodoc_type_aliases:
       FeatureCollection: dinf.FeatureCollection

tests/test_cli.py

@@ -292,7 +292,7 @@ def test_predict_example(self, tmp_path, sample_target):
                 {target}
                 --model {ex}
                 --discriminator {discriminator_file}
-                {output_file}
+                --output-file {output_file}
             """.split(),
             check=True,
             stdout=subprocess.PIPE,