Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rewrite Vector's documentation #545

Merged
merged 29 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
452cff0
give the logo some margins
jpivarski Dec 18, 2024
8479c05
remove the old; I'll use vector.readthedocs.io as a guide for refilli…
jpivarski Dec 18, 2024
2842fe9
switch from ReST to (Myst) Markdown
jpivarski Dec 18, 2024
4ad1777
style: pre-commit fixes
pre-commit-ci[bot] Dec 18, 2024
2fc82ac
skip test of non-existent notebook
jpivarski Dec 18, 2024
514fe26
Merge branch 'jpivarski/rewrite-documentation' of https://github.com/…
jpivarski Dec 18, 2024
bab2720
simplified the Overview page
jpivarski Dec 18, 2024
1765082
style: pre-commit fixes
pre-commit-ci[bot] Dec 18, 2024
ccb55e1
also mention geometric vs momentum
jpivarski Dec 18, 2024
60e7ff6
Merge branch 'jpivarski/rewrite-documentation' of https://github.com/…
jpivarski Dec 18, 2024
34768f0
style: pre-commit fixes
pre-commit-ci[bot] Dec 18, 2024
2f84f41
added interfaces
jpivarski Dec 18, 2024
3779656
pre-commit
jpivarski Dec 18, 2024
56d84ea
Merge branch 'jpivarski/rewrite-documentation' of https://github.com/…
jpivarski Dec 18, 2024
23f4495
rename 'talks' to 'presentations'
jpivarski Dec 18, 2024
1405409
finished the (public) reference documentation
jpivarski Dec 19, 2024
fd1c652
style: pre-commit fixes
pre-commit-ci[bot] Dec 19, 2024
6994385
made stubs for tutorials
jpivarski Dec 19, 2024
294db57
use SVG and make README match readthedocs
jpivarski Dec 19, 2024
e9ef240
Merge branch 'jpivarski/rewrite-documentation' of https://github.com/…
jpivarski Dec 19, 2024
f129631
style: pre-commit fixes
pre-commit-ci[bot] Dec 19, 2024
3cb8156
pre-commit
jpivarski Dec 19, 2024
47aa9b1
Merge branch 'jpivarski/rewrite-documentation' of https://github.com/…
jpivarski Dec 19, 2024
ce1ef28
finished the 'Vector objects' tutorial
jpivarski Dec 19, 2024
035b79f
finished the 'SymPy expressions' tutorial
jpivarski Dec 19, 2024
c8c9ff5
Merge branch 'main' into jpivarski/rewrite-documentation
jpivarski Dec 19, 2024
67f7700
finished the 'NumPy arrays' tutorial
jpivarski Dec 19, 2024
e91d929
finished the 'Awkward Arrays' tutorial
jpivarski Dec 20, 2024
d8efb14
the tutorials are all done now
jpivarski Dec 20, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
901 changes: 66 additions & 835 deletions README.md

Large diffs are not rendered by default.

60 changes: 30 additions & 30 deletions docs/_images/LogoSrc.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/coordinate-systems.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
323 changes: 323 additions & 0 deletions docs/_images/coordinate-systems.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/vector-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 0 additions & 8 deletions docs/api/backends/vector.backends._numba.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/backends/vector.backends._numba_object.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/backends/vector.backends.awkward.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/backends/vector.backends.awkward_constructors.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/backends/vector.backends.numba_numpy.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/backends/vector.backends.numpy.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/backends/vector.backends.object.rst

This file was deleted.

22 changes: 0 additions & 22 deletions docs/api/backends/vector.backends.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.Et.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.Et2.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.Mt.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.Mt2.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.add.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.beta.rst

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.boost_p4.rst

This file was deleted.

This file was deleted.

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.dot.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.equal.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.gamma.rst

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

8 changes: 0 additions & 8 deletions docs/api/compute/lorentz/vector._compute.lorentz.isclose.rst

This file was deleted.

Loading
Loading