Skip to content

Commit 6b60b57

Browse files
srjoglekar246srjoglekar246
committed
docs v1
1 parent fbca674 commit 6b60b57

25 files changed

+726
-3359
lines changed

‎doc/src/modules/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ access any SymPy module, or use this contens:
5252
physics/index.rst
5353
categories.rst
5454
diffgeom.rst
55+
vector/index.rst
5556

5657
Contributions to docs
5758
---------------------

‎doc/src/modules/vector/advanced.rst‎

Lines changed: 0 additions & 154 deletions
This file was deleted.

‎doc/src/modules/vector/api/classes.rst‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,32 @@
1-
=================
2-
Essential Classes
1+
===========================================
2+
Essential Class docstrings for sympy.vector
3+
===========================================
4+
5+
CoordSysCartesian
36
=================
47

5-
CoordinateSym
6-
=============
8+
.. autoclass:: sympy.vector.coordsysrect.CoordSysCartesian
9+
:members:
710

8-
.. autoclass:: sympy.physics.vector.frame.CoordinateSym
11+
.. automethod:: sympy.vector.coordsysrect.CoordSysCartesian.__init__
912

1013

11-
ReferenceFrame
12-
==============
14+
Vector
15+
======
1316

14-
.. autoclass:: sympy.physics.vector.frame.ReferenceFrame
17+
.. autoclass:: sympy.vector.vector.Vector
1518
:members:
1619

1720

18-
Vector
21+
Dyadic
1922
======
2023

21-
.. autoclass:: sympy.physics.vector.vector.Vector
24+
.. autoclass:: sympy.vector.dyadic.Dyadic
2225
:members:
2326

2427

25-
Dyadic
26-
======
28+
Del
29+
===
2730

28-
.. autoclass:: sympy.physics.vector.dyadic.Dyadic
31+
.. autoclass:: sympy.vector.deloperator.Del
2932
:members:

‎doc/src/modules/vector/api/fieldfunctions.rst‎

Lines changed: 0 additions & 53 deletions
This file was deleted.

‎doc/src/modules/vector/api/functions.rst‎

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎doc/src/modules/vector/api/kinematics.rst‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎doc/src/modules/vector/api/orienterclasses.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
===================================
2+
Docstrings for the Orienter classes
3+
===================================
4+
5+
6+
Orienter
7+
========
8+
9+
.. autoclass:: sympy.vector.orienters.Orienter
10+
:members:
11+
12+
13+
AxisOrienter
14+
============
15+
16+
.. autoclass:: sympy.vector.orienters.AxisOrienter
17+
:members:
18+
19+
.. automethod:: sympy.vector.orienters.AxisOrienter.__init__
20+
21+
22+
BodyOrienter
23+
============
24+
25+
.. autoclass:: sympy.vector.orienters.BodyOrienter
26+
:members:
27+
28+
.. automethod:: sympy.vector.orienters.BodyOrienter.__init__
29+
30+
SpaceOrienter
31+
=============
32+
33+
.. autoclass:: sympy.vector.orienters.SpaceOrienter
34+
:members:
35+
36+
.. automethod:: sympy.vector.orienters.SpaceOrienter.__init__
37+
38+
39+
QuaternionOrienter
40+
==================
41+
42+
.. autoclass:: sympy.vector.orienters.QuaternionOrienter
43+
:members:
44+
45+
.. automethod:: sympy.vector.orienters.QuaternionOrienter.__init__

‎doc/src/modules/vector/api/printing.rst‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)