Skip to content

Commit 2a3daae

Browse files
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>
1 parent 0fda04e commit 2a3daae

File tree

132 files changed

+4490
-9988
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

132 files changed

+4490
-9988
lines changed

README.md

+66-835
Large diffs are not rendered by default.

docs/_images/LogoSrc.svg

+30-30
Loading

docs/_images/coordinate-systems.png

95.6 KB
Loading

docs/_images/coordinate-systems.svg

+323
Loading

docs/_images/vector-logo.png

-2.47 KB
Loading

docs/api/backends/vector.backends._numba.rst

-8
This file was deleted.

docs/api/backends/vector.backends._numba_object.rst

-8
This file was deleted.

docs/api/backends/vector.backends.awkward.rst

-8
This file was deleted.

docs/api/backends/vector.backends.awkward_constructors.rst

-8
This file was deleted.

docs/api/backends/vector.backends.numba_numpy.rst

-8
This file was deleted.

docs/api/backends/vector.backends.numpy.rst

-8
This file was deleted.

docs/api/backends/vector.backends.object.rst

-8
This file was deleted.

docs/api/backends/vector.backends.rst

-22
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.Et.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.Et2.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.Mt.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.Mt2.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.add.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.beta.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.boostX_beta.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.boostX_gamma.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.boostY_beta.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.boostY_gamma.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.boostZ_beta.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.boostZ_gamma.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.boost_beta3.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.boost_p4.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.deltaRapidityPhi.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.deltaRapidityPhi2.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.dot.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.equal.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.gamma.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.is_lightlike.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.is_spacelike.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.is_timelike.rst

-8
This file was deleted.

docs/api/compute/lorentz/vector._compute.lorentz.isclose.rst

-8
This file was deleted.

0 commit comments

Comments
 (0)