docs move API changes to changelog (#34)

Co-authored-by: Geevarghese George <4496097+thatgeeman@users.noreply.github.com>

Author: thatgeeman

README.md

@@ -3,34 +3,6 @@
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
-### Version 0.5 API changes
-
-Python 3.8 remains the supported development and CI runtime. Bounding
-box parsing now accepts a single dictionary, a list of dictionaries, a
-JSON string, Python numeric coordinates, and NumPy numeric coordinates.
-A dictionary without a label receives the label `"unknown"`:
-
-``` python
-from pybx.basics import get_bx
-
-box = get_bx({"x_min": 130, "y_min": 63, "x_max": 225, "y_max": 180})
-box.label
-```
-
-Inputs are validated as Pascal VOC boxes: exactly four coordinates and
-an optional string or integer label, non-negative coordinates, and
-maxima greater than minima. For explicit construction, use
-[`bbx`](https://thatgeeman.github.io/pybx/basics.html#bbx) for
-coordinate lists,
-[`dbx`](https://thatgeeman.github.io/pybx/basics.html#dbx) for
-dictionaries, and
-[`jbx`](https://thatgeeman.github.io/pybx/basics.html#jbx) for JSON
-strings or dictionaries. The former `lbx` alias has been removed; use
-[`bbx`](https://thatgeeman.github.io/pybx/basics.html#bbx) instead.
-
-`Bx.xywh()` and `Bx.yolo()` now include the label as the fifth value in
-their returned box. IoU values retain full floating-point precision.
-
 [![PyPI
 version](https://badge.fury.io/py/pybx.svg)](https://badge.fury.io/py/pybx)
 [![Open In

nbs/01_basics.ipynb

@@ -6,7 +6,7 @@
    "source": [
     "# Basic objects\n",
     "\n",
-    "> Basic object types and methods utilized in `pybx`"
+    "> Basic object types and methods used in PyBx"
    ]
   },
   {

nbs/02_utils.ipynb

@@ -6,7 +6,7 @@
    "source": [
     "# Utilities\n",
     "\n",
-    "> Utility functions used in `pybx` to calculate anchor boxes, among others."
+    "> Utility functions used in PyBx to calculate anchor boxes, among others."
    ]
   },
   {

nbs/07_changelog.ipynb

@@ -0,0 +1,42 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Changelog\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 0.5.0\n",
+    "\n",
+    "### API changes\n",
+    "\n",
+    "Python 3.8 remains the supported development and CI runtime. Bounding box parsing now accepts a single dictionary, a list of dictionaries, a JSON string, Python numeric coordinates, and NumPy numeric coordinates. A dictionary without a label receives the label `\"unknown\"`:\n",
+    "\n",
+    "```python\n",
+    "from pybx.basics import get_bx\n",
+    "\n",
+    "box = get_bx({\"x_min\": 130, \"y_min\": 63, \"x_max\": 225, \"y_max\": 180})\n",
+    "box.label\n",
+    "```\n",
+    "\n",
+    "Inputs are validated as Pascal VOC boxes: exactly four coordinates and an optional string or integer label, non-negative coordinates, and maxima greater than minima. For explicit construction, use `bbx` for coordinate lists, `dbx` for dictionaries, and `jbx` for JSON strings or dictionaries. The former `lbx` alias has been removed; use `bbx` instead.\n",
+    "\n",
+    "`Bx.xywh()` and `Bx.yolo()` now include the label as the fifth value in their returned box. IoU values retain full floating-point precision.\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "pybx-kernel",
+   "language": "python",
+   "name": "pybx-kernel"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

nbs/index.ipynb

@@ -7,26 +7,6 @@
     "# PyBx\n"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Version 0.5 API changes\n",
-    "\n",
-    "Python 3.8 remains the supported development and CI runtime. Bounding box parsing now accepts a single dictionary, a list of dictionaries, a JSON string, Python numeric coordinates, and NumPy numeric coordinates. A dictionary without a label receives the label `\"unknown\"`:\n",
-    "\n",
-    "```python\n",
-    "from pybx.basics import get_bx\n",
-    "\n",
-    "box = get_bx({\"x_min\": 130, \"y_min\": 63, \"x_max\": 225, \"y_max\": 180})\n",
-    "box.label\n",
-    "```\n",
-    "\n",
-    "Inputs are validated as Pascal VOC boxes: exactly four coordinates and an optional string or integer label, non-negative coordinates, and maxima greater than minima. For explicit construction, use `bbx` for coordinate lists, `dbx` for dictionaries, and `jbx` for JSON strings or dictionaries. The former `lbx` alias has been removed; use `bbx` instead.\n",
-    "\n",
-    "`Bx.xywh()` and `Bx.yolo()` now include the label as the fifth value in their returned box. IoU values retain full floating-point precision.\n"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},

nbs/sidebar.yml

@@ -9,3 +9,4 @@ website:
       - 04_sample.ipynb
       - 05_vis.ipynb
       - 06_excepts.ipynb
+      - 07_changelog.ipynb