docs: rewrite Vector's documentation (#545)

* give the logo some margins * remove the old; I'll use vector.readthedocs.io as a guide for refilling it * switch from ReST to (Myst) Markdown * style: pre-commit fixes * skip test of non-existent notebook * simplified the Overview page * style: pre-commit fixes * also mention geometric vs momentum * style: pre-commit fixes * added interfaces * pre-commit * rename 'talks' to 'presentations' * finished the (public) reference documentation * style: pre-commit fixes * made stubs for tutorials * use SVG and make README match readthedocs * style: pre-commit fixes * pre-commit * finished the 'Vector objects' tutorial * finished the 'SymPy expressions' tutorial * finished the 'NumPy arrays' tutorial * finished the 'Awkward Arrays' tutorial * the tutorials are all done now --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
scikit-hep · Dec 20, 2024 · 2a3daae · 2a3daae
1 parent 0fda04e
commit 2a3daae
Show file tree

Hide file tree

Showing 132 changed files with 4,490 additions and 9,988 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/_images/LogoSrc.svg b/docs/_images/LogoSrc.svg
diff --git a/docs/_images/coordinate-systems.png b/docs/_images/coordinate-systems.png
diff --git a/docs/_images/coordinate-systems.svg b/docs/_images/coordinate-systems.svg
diff --git a/docs/_images/vector-logo.png b/docs/_images/vector-logo.png
diff --git a/docs/api/backends/vector.backends._numba.rst b/docs/api/backends/vector.backends._numba.rst
diff --git a/docs/api/backends/vector.backends._numba_object.rst b/docs/api/backends/vector.backends._numba_object.rst
diff --git a/docs/api/backends/vector.backends.awkward.rst b/docs/api/backends/vector.backends.awkward.rst
diff --git a/docs/api/backends/vector.backends.awkward_constructors.rst b/docs/api/backends/vector.backends.awkward_constructors.rst
diff --git a/docs/api/backends/vector.backends.numba_numpy.rst b/docs/api/backends/vector.backends.numba_numpy.rst
diff --git a/docs/api/backends/vector.backends.numpy.rst b/docs/api/backends/vector.backends.numpy.rst
diff --git a/docs/api/backends/vector.backends.object.rst b/docs/api/backends/vector.backends.object.rst
diff --git a/docs/api/backends/vector.backends.rst b/docs/api/backends/vector.backends.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.Et.rst b/docs/api/compute/lorentz/vector._compute.lorentz.Et.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.Et2.rst b/docs/api/compute/lorentz/vector._compute.lorentz.Et2.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.Mt.rst b/docs/api/compute/lorentz/vector._compute.lorentz.Mt.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.Mt2.rst b/docs/api/compute/lorentz/vector._compute.lorentz.Mt2.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.add.rst b/docs/api/compute/lorentz/vector._compute.lorentz.add.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.beta.rst b/docs/api/compute/lorentz/vector._compute.lorentz.beta.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.boostX_beta.rst b/docs/api/compute/lorentz/vector._compute.lorentz.boostX_beta.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.boostX_gamma.rst b/docs/api/compute/lorentz/vector._compute.lorentz.boostX_gamma.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.boostY_beta.rst b/docs/api/compute/lorentz/vector._compute.lorentz.boostY_beta.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.boostY_gamma.rst b/docs/api/compute/lorentz/vector._compute.lorentz.boostY_gamma.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.boostZ_beta.rst b/docs/api/compute/lorentz/vector._compute.lorentz.boostZ_beta.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.boostZ_gamma.rst b/docs/api/compute/lorentz/vector._compute.lorentz.boostZ_gamma.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.boost_beta3.rst b/docs/api/compute/lorentz/vector._compute.lorentz.boost_beta3.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.boost_p4.rst b/docs/api/compute/lorentz/vector._compute.lorentz.boost_p4.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.deltaRapidityPhi.rst b/docs/api/compute/lorentz/vector._compute.lorentz.deltaRapidityPhi.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.deltaRapidityPhi2.rst b/docs/api/compute/lorentz/vector._compute.lorentz.deltaRapidityPhi2.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.dot.rst b/docs/api/compute/lorentz/vector._compute.lorentz.dot.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.equal.rst b/docs/api/compute/lorentz/vector._compute.lorentz.equal.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.gamma.rst b/docs/api/compute/lorentz/vector._compute.lorentz.gamma.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.is_lightlike.rst b/docs/api/compute/lorentz/vector._compute.lorentz.is_lightlike.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.is_spacelike.rst b/docs/api/compute/lorentz/vector._compute.lorentz.is_spacelike.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.is_timelike.rst b/docs/api/compute/lorentz/vector._compute.lorentz.is_timelike.rst
diff --git a/docs/api/compute/lorentz/vector._compute.lorentz.isclose.rst b/docs/api/compute/lorentz/vector._compute.lorentz.isclose.rst