docs: add logo

scikit-hep · Apr 8, 2021 · beff424 · beff424
1 parent 16c3ce4
commit beff424
Show file tree

Hide file tree

Showing 6 changed files with 108 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+<img alt="Vector logo" width="433" src="https://raw.githubusercontent.com/scikit-hep/vector/develop/docs/_images/vector-logo.png"/>
+
 # Vector
 
 [![Actions Status][actions-badge]][actions-link]

diff --git a/docs/_images/LogoSrc.svg b/docs/_images/LogoSrc.svg
diff --git a/docs/_images/vector-logo.png b/docs/_images/vector-logo.png
diff --git a/docs/changelog.md 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
@@ -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
@@ -13,6 +13,7 @@ Vector: vectorized 2D, 3D, and Lorentz vectors
    usage/intro
    usage/structure
    usage/vector_design_prototype
+   changelog
 
 .. toctree::
    :maxdepth: 3