Docstrings (#48)

* Add doc auto generate from docstrings (use numpy style)
* Add python formatter
* Add devcontainer config

Author: dasimagin

.devcontainer/devcontainer.json

@@ -0,0 +1,47 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
+{
+    "name": "cart-pole",
+
+    // Update the 'dockerComposeFile' list if you have more compose files or use different names.
+    // The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
+    "dockerComposeFile": ["../docker-compose.yaml"],
+
+    // The 'service' property is the name of the service for the container that VS Code should
+    // use. Update this value and .devcontainer/docker-compose.yml to the real service name.
+    "service": "cartpole",
+
+    // The optional 'workspaceFolder' property is the path VS Code should open by default when
+    // connected. This is typically a file mount in .devcontainer/docker-compose.yml
+    "workspaceFolder": "/cartpole"
+
+    // Features to add to the dev container. More info: https://containers.dev/features.
+    // "features": {},
+
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+
+    // Uncomment the next line if you want start specific services in your Docker Compose config.
+    // "runServices": [],
+
+    // Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+    // "shutdownAction": "none",
+
+    // Uncomment the next line to run commands after the container is created.
+    // "postCreateCommand": "cat /etc/os-release",
+
+    // Configure tool-specific properties.
+    "customizations": {
+        "vscode": {
+            "extensions": [
+                "ms-python.python",
+                "ms-python.vscode-pylance",
+                "charliermarsh.ruff",
+                "yzhang.markdown-all-in-one"
+            ]
+        }
+    }
+
+    // Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
+    // "remoteUser": "cartpole"
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1 @@
+version: '3.9'

Dockerfile

@@ -12,6 +12,7 @@ RUN apt update -q \
     && apt install -yq --no-install-recommends \
         build-essential \
         coinor-libipopt-dev \
+        git \
         python3 \
         python3-dev \
         python3-pip \

cartpole/__init__.py

@@ -3,15 +3,3 @@
 from cartpole.common import CartPoleBase, Config, Error, State, Target, Limits, Parameters  
 from cartpole.eval import find_parameters
 from cartpole.simulator import Simulator, SimulatorInfo
-
-
-# We suggest to use loging in following way:
-# import cartpole.log as log
-#
-# log.setup(log_path='evaluation_example.mcap')
-# log.info('hello world!')
-# ...
-# log.close()
-
-
-