diff --git a/README.md b/README.md index 0af68656..a1b09098 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +Vector logo + # Vector [![Actions Status][actions-badge]][actions-link] diff --git a/docs/_images/LogoSrc.svg b/docs/_images/LogoSrc.svg new file mode 100644 index 00000000..7d81c1e0 --- /dev/null +++ b/docs/_images/LogoSrc.svg @@ -0,0 +1,85 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + diff --git a/docs/_images/vector-logo.png b/docs/_images/vector-logo.png new file mode 100644 index 00000000..5d24f491 Binary files /dev/null and b/docs/_images/vector-logo.png differ diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 00000000..7f73beb4 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,17 @@ +# Changelog + +## Version 0.8 + +First release to PyPI. Initial implementation. Initial features: + +* 2D, 3D, and Lorentz vectors +* Single, Array, and Awkward forms +* Supports Numba / Awkward + Numba +* Multiple coordinate systems +* Geometric / momentum versions +* Statically typed + +You can currently construct vectors using `obj`/`arr`/`awk` (or +`obj`/`array`/`Array`) for single, NumPy, and Awkward vectors, respectively. +The next version is likely to improve the vector construction process. + diff --git a/docs/conf.py b/docs/conf.py index fefda7af..45ab5719 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -70,6 +70,9 @@ html_baseurl = "https://vector.readthedocs.io/en/latest/" +html_logo = "_images/vector-logo.png" +html_title = "Vector docs" + html_theme_options = { "home_page_in_toc": True, diff --git a/docs/index.rst b/docs/index.rst index 596b59c5..e3ab0311 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,7 @@ Vector: vectorized 2D, 3D, and Lorentz vectors usage/intro usage/structure usage/vector_design_prototype + changelog .. toctree:: :maxdepth: 3