docs: render module level docstrings in documentation (#218)

* docs: make docstrings render in sphinx

* Remove the 'Note' for API docs in `index.rst`

Author: Saransh-cpp

docs/index.rst

@@ -86,8 +86,6 @@ API reference
 -------------
 The API reference details the functionality of each ``class`` and ``function`` present in ``vector``'s codebase.
 
-**Note**: Adding missing docstrings is still in progress.
-
 .. toctree::
    :maxdepth: 8
    :caption: API Reference

src/vector/_compute/lorentz/Et2.py

@@ -3,14 +3,13 @@
 # Distributed under the 3-clause BSD license, see accompanying file LICENSE
 # or https://github.com/scikit-hep/vector for details.
 
-import typing
-
 """
 .. code-block:: python
 
     @property
     Lorentz.Et2(self)
 """
+import typing
 
 import numpy
 

src/vector/_compute/lorentz/Mt.py

@@ -3,14 +3,13 @@
 # Distributed under the 3-clause BSD license, see accompanying file LICENSE
 # or https://github.com/scikit-hep/vector for details.
 
-import typing
-
 """
 .. code-block:: python
 
     @property
     Lorentz.Mt(self)
 """
+import typing
 
 import numpy
 

src/vector/_compute/lorentz/Mt2.py

@@ -3,14 +3,13 @@
 # Distributed under the 3-clause BSD license, see accompanying file LICENSE
 # or https://github.com/scikit-hep/vector for details.
 
-import typing
-
 """
 .. code-block:: python
 
     @property
     Lorentz.Mt2(self)
 """
+import typing
 
 import numpy
 

src/vector/_compute/lorentz/add.py

@@ -3,13 +3,12 @@
 # Distributed under the 3-clause BSD license, see accompanying file LICENSE
 # or https://github.com/scikit-hep/vector for details.
 
-import typing
-
 """
 .. code-block:: python
 
     Lorentz.add(self, other)
 """
+import typing
 
 import numpy
 

src/vector/_compute/lorentz/beta.py

@@ -3,14 +3,13 @@
 # Distributed under the 3-clause BSD license, see accompanying file LICENSE
 # or https://github.com/scikit-hep/vector for details.
 
-import typing
-
 """
 .. code-block:: python
 
     @property
     Lorentz.beta(self)
 """
+import typing
 
 import numpy
 

src/vector/_compute/lorentz/boostX_beta.py

@@ -3,13 +3,12 @@
 # Distributed under the 3-clause BSD license, see accompanying file LICENSE
 # or https://github.com/scikit-hep/vector for details.
 
-import typing
-
 """
 .. code-block:: python
 
     Lorentz.boostX(self, beta=...)
 """
+import typing
 
 import numpy
 

src/vector/_compute/lorentz/boostX_gamma.py

@@ -3,13 +3,12 @@
 # Distributed under the 3-clause BSD license, see accompanying file LICENSE
 # or https://github.com/scikit-hep/vector for details.
 
-import typing
-
 """
 .. code-block:: python
 
     Lorentz.boostX(self, gamma=)
 """
+import typing
 
 import numpy
 

src/vector/_compute/lorentz/boostY_beta.py

@@ -3,13 +3,12 @@
 # Distributed under the 3-clause BSD license, see accompanying file LICENSE
 # or https://github.com/scikit-hep/vector for details.
 
-import typing
-
 """
 .. code-block:: python
 
     Lorentz.boostY(self, beta=...)
 """
+import typing
 
 import numpy
 

src/vector/_compute/lorentz/boostY_gamma.py

@@ -3,13 +3,12 @@
 # Distributed under the 3-clause BSD license, see accompanying file LICENSE
 # or https://github.com/scikit-hep/vector for details.
 
-import typing
-
 """
 .. code-block:: python
 
     Lorentz.boostY(self, gamma=...)
 """
+import typing
 
 import numpy