Publish 0.2.0; fix docs

bliss/api.py

@@ -1,6 +1,6 @@
 import base64
 from pathlib import Path
-from typing import Dict, Literal, Optional, Tuple
+from typing import Dict, Literal, Optional, Tuple, TypeAlias
 
 import requests
 import torch
@@ -17,10 +17,12 @@
 from bliss.surveys import sdss_download
 from bliss.train import train as _train
 
-SurveyType = Literal["decals", "hst", "lsst", "sdss"]
+SurveyType: TypeAlias = Literal["decals", "hst", "lsst", "sdss"]
 
 
 class BlissClient:
+    """Client for interacting with the BLISS API."""
+
     def __init__(self, cwd: str):
         self._cwd = cwd
         # cached_data_path (str): Path to directory where cached data will be stored.

docs/docsrc/conf.py

@@ -66,3 +66,35 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+
+# For nbsphinx
+nbsphinx_execute = "never"
+
+# Below code is necessary to ensure pandoc is available for use by nbsphinx.
+# See https://stackoverflow.com/questions/62398231/building-docs-fails-due-to-missing-pandoc/71585691#71585691 # noqa: E501 # pylint: disable=line-too-long
+from inspect import getsourcefile  # noqa: E402 # pylint: disable=wrong-import-position
+
+# Get path to directory containing this file, conf.py.
+PATH_OF_THIS_FILE = getsourcefile(lambda: 0)  # noqa: WPS522
+DOCS_DIRECTORY = os.path.dirname(os.path.abspath(PATH_OF_THIS_FILE))  # type: ignore
+
+
+def ensure_pandoc_installed(_):
+    import pypandoc  # pylint: disable=import-outside-toplevel
+
+    # Download pandoc if necessary. If pandoc is already installed and on
+    # the PATH, the installed version will be used. Otherwise, we will
+    # download a copy of pandoc into docs/bin/ and add that to our PATH.
+    pandoc_dir = os.path.join(DOCS_DIRECTORY, "bin")
+    # Add dir containing pandoc binary to the PATH environment variable
+    if pandoc_dir not in os.environ["PATH"].split(os.pathsep):
+        os.environ["PATH"] += os.pathsep + pandoc_dir
+    pypandoc.ensure_pandoc_installed(
+        version="2.11.4",
+        targetfolder=pandoc_dir,
+        delete_installer=True,
+    )
+
+
+def setup(app):
+    app.connect("builder-inited", ensure_pandoc_installed)

docs/docsrc/tutorials/index.rst

@@ -0,0 +1,5 @@
+Tutorials
+=========
+
+.. toctree::
+    notebooks/tutorial