Docs update

kubasaw · Oct 5, 2019 · e926189 · e926189
1 parent 0ccbd71
commit e926189
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/car/motion.py b/car/motion.py
@@ -1,12 +1,14 @@
-"""Module which is holding Car classes 
+"""Car motion class
+   ================
+   This part of the module contains the vehicle motion simulator class.
 """
 
 import numpy as np
 from scipy.integrate import solve_ivp
 
 
 class motion:
-    """Car motion
+    """Car motion class
     """
 
     def __init__(self):

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,7 +6,7 @@
 Welcome to carSim's documentation!
 ==================================
 
-.. automodule:: car.car
+.. automodule:: car.motion
 	:members:
 
 .. toctree::