Bump version to 0.1.3 (#56)

Makefile

@@ -2,7 +2,7 @@ VERSION ?= $(shell git rev-parse --short HEAD)
 CONDA_ENV_NAME ?= vflow
 HATCH_ENV_NAME ?= test
 
-.PHONY: build_conda_env build_ipykernel test_% run_tests fix_styles
+.PHONY: build_conda_env build_ipykernel test_% run_tests fix_styles build_docs
 
 build_conda_env:
 	conda create -n $(CONDA_ENV_NAME) -y python==3.10 pip
@@ -20,3 +20,6 @@ run_tests:
 
 fix_styles:
 	hatch -v run style:fmt
+
+build_docs:
+	hatch -v run docs:build

README.md

@@ -82,7 +82,10 @@ Once we've written this pipeline, we can easily measure the stability of metrics
 
 See the [docs](https://yu-group.github.io/veridical-flow/) for reference on the API
 
-> **Notebook examples** (Note that some of these require more dependencies than just those required for vflow - to install all, use the `notebooks` dependencies in the `setup.py` file)
+> **Notebook examples**
+>
+> Note that some of these require more dependencies than just those required for
+> `vflow`. To install all, run `pip install vflow[nb]`.
 >
 > [Synthetic classification](https://yu-group.github.io/veridical-flow/notebooks/00_synthetic_classification.html)
 >

docs/contributing.md

@@ -5,24 +5,38 @@ Contributions are very welcome!
 
 ## Getting Started
 
-If you are looking to contribute to the *veridical-flow* codebase, the best place to start is the [GitHub "issues" tab](https://github.com/Yu-Group/veridical-flow/issues). This is also a great place for filing bug reports and suggesting improvement to the code and documentation.
+If you are looking to contribute to the `veridical-flow` codebase, the best
+place to start is the [GitHub "issues" tab](https://github.com/Yu-Group/veridical-flow/issues). This is also a great
+place for filing bug reports and suggesting improvement to the code and
+documentation.
 
 ## Filing Issues
 
-If you notice a bug in the code or documentation, or have suggestions for how we can improve either, feel free to create an issue on the [GitHub "issues" tab](https://github.com/Yu-Group/veridical-flow/issues) using [GitHub's "issue" form](https://github.com/Yu-Group/veridical-flow/issues/new). Please be as descriptive as possible we so can best address your issue.
+If you notice a bug in the code or documentation, or have suggestions for how we
+can improve either, feel free to create an issue on the [GitHub "issues" tab](https://github.com/Yu-Group/veridical-flow/issues) using [GitHub's "issue" form](https://github.com/Yu-Group/veridical-flow/issues/new). Please be as
+descriptive as possible we so can best address your issue.
 
 ## Contributing to the Codebase
 
-After forking the [repository](https://github.com/Yu-Group/veridical-flow), be sure to create a development environment that is separate from your existing Python environment so that you can make and test changes without compromising your own work environment. To develop locally, navigate to the repo root directory and run `python setup.py develop --user`.
-
-Before submitting your changes for review, please make sure to check that your changes do not break any tests. 
-- [Tests](tests) are written with [pytest](https://docs.pytest.org/en/stable/), and can be run by running `pytest` in the repo root directory. 
-- [Docs](https://csinva.io/imodels/docs/) are built using [pdoc3](https://pdoc3.github.io/pdoc/) (install with `pip install pdoc3`, and can be built by navigating to the `docs` directory and running `./build_docs.sh`. Note that we follow the [numpy docstrings](https://numpydoc.readthedocs.io/en/latest/format.html) convention.
-
-Once your changes are ready to be submitted, make sure to push your change to GitHub before creating a pull request. See [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for instruction on how to create a pull request from a fork. We will review your changes, and you may be asked to make additional changes before it is finally ready to merge. Once it is ready, we will merge your pull request, and you have will successfully contributed to the codebase 🎉!
-
-
-
-
-
-
+After forking the [repository](https://github.com/Yu-Group/veridical-flow), be
+sure to create a development environment that is separate from your existing
+Python environment so that you can make and test changes without compromising
+your own work environment. To develop locally, navigate to the repo root
+directory and run `python setup.py develop --user`.
+
+Before submitting your changes for review, please make sure to check that your
+changes do not break any tests.
+
+- [Tests](tests) are written with [pytest](https://docs.pytest.org/en/stable/),
+  and can be run by running `pytest` in the repo root directory.
+- [Docs](https://csinva.io/imodels/docs/) can be built by running `hatch run
+  docs:build`. Note that we follow the [numpy
+  docstrings](https://numpydoc.readthedocs.io/en/latest/format.html) convention.
+
+Once your changes are ready to be submitted, make sure to push your change to
+GitHub before creating a pull request. See
+[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
+for instruction on how to create a pull request from a fork. We will review your
+changes, and you may be asked to make additional changes before it is finally
+ready to merge. Once it is ready, we will merge your pull request, and you have
+will successfully contributed to the codebase 🎉!