add requirements dir (AtsushiSakai#630)

* add requirements dir

* add requirements dir

* add requirements dir

Author: AtsushiSakai

.circleci/config.yml

@@ -14,7 +14,7 @@ jobs:
           command: |
             python -m venv venv
             . venv/bin/activate
-            pip install -r requirements.txt
+            pip install -r docs/doc_requirements.txt
             cd docs;make html
       - store_artifacts:
           path: docs/_build/html/

.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
 - package-ecosystem: pip
-  directory: "/"
+  directory: "/requirements"
   schedule:
     interval: weekly
     time: "20:00"

.github/workflows/Linux_CI.yml

@@ -27,7 +27,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install -r requirements.txt
+        python -m pip install -r requirements/requirements.txt
     - name: do all unit tests
       run: bash runtests.sh
 

.github/workflows/MacOS_CI.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install numpy # cvxpy install workaround
-          pip install -r requirements.txt
+          #pip install numpy # cvxpy install workaround
+          pip install -r requirements/requirements.txt
       - name: do all unit tests
         run: bash runtests.sh

README.md

@@ -141,11 +141,11 @@ All animation gifs are stored here: [AtsushiSakai/PythonRoboticsGifs: Animation
 
 using conda :
 
-> conda env create -f environment.yml
+> conda env create -f requirements/environment.yml
  
 using pip :
 
-> pip install -r requirements.txt
+> pip install -r requirements/requirements.txt
 
 
 3. Execute python script in each directory.

appveyor.yml

@@ -37,7 +37,7 @@ install:
   - SET PATH=%PYTHON%;%PYTHON%\Scripts;%PYTHON%\Library\bin;%PATH%
   - SET PATH=%PATH%;C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin
   - "python -m pip install --upgrade pip"
-  - "python -m pip install -r requirements.txt"
+  - "python -m pip install -r requirements/requirements.txt"
   - "python -m pip install pytest-xdist"
 
   # Check that we have the expected version and architecture for Python

docs/doc_requirements.txt

@@ -1,3 +1,3 @@
 sphinx == 4.3.2 # For sphinx documentation
 sphinx_rtd_theme == 1.0.0
-IPython == 8.0.1 # For sphinx documentation
+IPython == 7.31.1 # For sphinx documentation

docs/getting_started_main.rst

@@ -67,13 +67,13 @@ using conda :
 
 .. code-block::
 
-    >$ conda env create -f environment.yml
+    >$ conda env create -f requirements/environment.yml
 
 using pip :
 
 .. code-block::
 
-    >$ pip install -r requirements.txt
+    >$ pip install -r requirements/requirements.txt
 
 
 3. Execute python script in each directory.

docs/modules/control/move_to_a_pose_control/move_to_a_pose_control.rst

@@ -1,5 +1,12 @@
+Move to a Pose Control
+----------------------
+
+In this section, we present the logic of PathFinderController that drives a car from a start pose (x, y, theta) to a goal pose. A simulation of moving to a pose control is presented below.
+
+.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathTracking/move_to_pose/animation.gif
+
 Position Control of non-Holonomic Systems
------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This section explains the logic of a position controller for systems with constraint (non-Holonomic system).
 
@@ -9,20 +16,11 @@ To describe the configuration of a car on a 2D plane, we need three DOFs (i.e.,
 
 Note that a car is normally a non-Holonomic system but if the road is slippery, the car turns into a Holonomic system and thus it needs three independent commands to be controlled.
 
-Move to a Pose Control
-----------------------
-
-In this section, we present the logic of PathFinderController that drives a car from a start pose (x, y, theta) to a goal pose. A simulation of moving to a pose control is presented below.
-
-.. image:: https://github.com/AtsushiSakai/PythonRoboticsGifs/raw/master/PathTracking/move_to_pose/animation.gif
-
-
-
 PathFinderController class
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Constructor
-~~~~~~~~~~~
+^^^^^^^^^^^
 
 .. code-block:: ipython3
 
@@ -38,7 +36,7 @@ Parameters:
 
 
 Member function(s)
-~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^
 
 .. code-block:: ipython3
 
@@ -99,7 +97,8 @@ The final angular speed command is given by
 The linear and angular speeds (Equations :eq:`eq1` and :eq:`eq2`) are the output of the algorithm.
 
 Move to a Pose Robot (Class)
-----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 This program (move_to_pose_robot.py) provides a Robot class to define different robots with different specifications. 
 Using this class, you can simulate different robots simultaneously and compare the effect of your parameter settings.
 
@@ -108,10 +107,10 @@ Using this class, you can simulate different robots simultaneously and compare t
 Note: The robot class is based on PathFinderController class in 'the move_to_pose.py'.
 
 Robot Class
-~~~~~~~~~~~
+^^^^^^^^^^^^
 
 Constructor
-~~~~~~~~~~~
+^^^^^^^^^^^^
 
 .. code-block:: ipython3
 
@@ -128,7 +127,7 @@ Parameters:
 - | **path_finder_controller** : (PathFinderController) A configurable controller to finds the path and calculates command linear and angular velocities.
 
 Member function(s)
-~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: ipython3
 
@@ -151,12 +150,10 @@ Parameters:
 
 - | **dt** : <float> time increment
 
-See Also 
---------
-- PathFinderController class
 
 
-Ref:
-----
+References
+~~~~~~~~~~~~
+- PathFinderController class
 -  `P. I. Corke, "Robotics, Vision and Control" \| SpringerLink
    p102 <https://link.springer.com/book/10.1007/978-3-642-20144-8>`__