Merge pull request #118 from stefmolin/ref-blog-post

Add references to Data Morph blog post

README.md

@@ -60,6 +60,8 @@ Data Morph transforms an input dataset of 2D points into select shapes, while pr
   <br/>
 </div>
 
+Read more about the creation of Data Morph [here](https://medium.com/@stefaniemolin/data-morph-moving-beyond-the-datasaurus-dozen-156927b20f8c).
+
 ## Installation
 
 Data Morph can be installed with `pip`:

docs/cli.rst

@@ -8,33 +8,48 @@ CLI Reference
 
 ----
 
+
 Examples
 --------
 
-1. Morph the panda shape into a star::
+1. Morph the panda shape into a star:
+
+   .. code-block:: console
 
     $ data-morph --start-shape panda --target-shape star
 
-2. Morph the panda shape into all available target shapes::
+2. Morph the panda shape into all available target shapes:
+
+   .. code-block:: console
 
     $ data-morph --start-shape panda --target-shape all
 
-3. Morph the cat, dog, and panda shapes into the circle and slant_down shapes::
+3. Morph the cat, dog, and panda shapes into the circle and slant_down shapes:
+
+   .. code-block:: console
 
     $ data-morph --start-shape cat dog panda --target-shape circle slant_down
 
-4. Morph the dog shape into upward-slanting lines over 50,000 iterations with seed 1::
+4. Morph the dog shape into upward-slanting lines over 50,000 iterations with seed 1:
+
+   .. code-block:: console
 
     $ data-morph --start-shape dog --target-shape slant_up --iterations 50000 --seed 1
 
-5. Morph the cat shape into a circle, preserving summary statistics to 3 decimal places::
+5. Morph the cat shape into a circle, preserving summary statistics to 3 decimal places:
+
+   .. code-block:: console
 
     $ data-morph --start-shape cat --target-shape circle --decimals 3
 
-6. Morph the music shape into a bullseye, specifying the output directory::
+6. Morph the music shape into a bullseye, specifying the output directory:
+
+   .. code-block:: console
 
     $ data-morph --start-shape music --target-shape bullseye --output-dir path/to/dir
 
-7. Morph the sheep shape into vertical lines, slowly ramping in and out for the animation::
+7. Morph the sheep shape into vertical lines, slowly ramping in and out for the animation:
+
+   .. code-block:: console
 
     $ data-morph --start-shape sheep --target-shape v_lines --ramp-in --ramp-out

docs/index.rst

@@ -1,8 +1,3 @@
-.. Data Morph documentation master file, created by
-   sphinx-quickstart on Sat Mar 11 15:15:31 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root ``toctree`` directive.
-
 Data Morph
 ==========
 

src/data_morph/__init__.py

@@ -13,12 +13,15 @@
 Identical Statistics through Simulated Annealing* by Justin Matejka and George Fitzmaurice
 (ACM CHI 2017).
 
-The paper and video can be found on the Autodesk Research website `here
+The paper and video can be found on the `Autodesk Research website
 <https://www.research.autodesk.com/publications/same-stats-different-graphs-generating-datasets-with-varied-appearance-and-identical-statistics-through-simulated-annealing/>`_.
 The version of the code placed on GitHub at
 `jmatejka/same-stats-different-graphs <https://github.com/jmatejka/same-stats-different-graphs>`_,
 served as the starting point for the Data Morph code base, which is on GitHub at
 `stefmolin/data-morph <https://github.com/stefmolin/data-morph>`_.
+
+Read more about the creation of Data Morph `here
+<https://medium.com/@stefaniemolin/data-morph-moving-beyond-the-datasaurus-dozen-156927b20f8c>`_.
 """
 
 __version__ = '0.2.0.dev0'