No programoutput anymore.

doc/conf.py

@@ -47,7 +47,6 @@
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
-    'sphinxcontrib.programoutput',
     'sphinx.ext.napoleon',
     # 'sphinxcontrib.katex',
 ]

doc/notes/02 Usage.rst

@@ -5,7 +5,33 @@ Usage
 Training/Replaying
 ------------------
 
-.. command-output:: python -m digideep.main --help
+.. code-block:: bash
+    :caption: Command-line arguments
+
+    $ python -m digideep.main --help
+    usage: main.py [-h] [--load-checkpoint <path>] [--play]
+                  [--session-path <path>] [--log-level <n>] [--visdom]
+                  [--visdom-port <n>] [--monitor-cpu] [--monitor-gpu]
+                  [--params <name>] [--cpanel <json dictionary>]
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      --load-checkpoint <path>
+                            Load a checkpoint to resume training from that point.
+      --play                Will play the stored policy.
+      --session-path <path>
+                            The path to store the sessions. Default is in /tmp
+      --log-level <n>       The logging level: 0 (debug and above), 1 (info and
+                            above), 2 (warn and above), 3 (error and above), 4
+                            (fatal and above)
+      --visdom              Whether to use visdom or not!
+      --visdom-port <n>     The port of visdom server, it's on 8097 by default.
+      --monitor-cpu         Use to monitor CPU resource statistics on Visdom.
+      --monitor-gpu         Use to monitor GPU resource statistics on Visdom.
+      --params <name>       Choose the parameter set.
+      --cpanel <json dictionary>
+                            Set the parameters of the cpanel by a json dictionary.
+
 
 .. code-block:: bash
     :caption: Example Usage
@@ -42,28 +68,50 @@ Training/Replaying
 Playing for Debugging
 ---------------------
 
-.. command-output:: python -m digideep.environment.play --help
+..code-block:: bash
+    :caption: Command-line arguments
+
+    $ python -m digideep.environment.play --help
+    usage: play.py [-h] [--list-include [<pattern>]] [--list-exclude [<pattern>]]
+                  [--module <module_name>] [--model <model_name>] [--runs <n>]
+                  [--n-step <n>] [--delay <ms>] [--no-action]
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      --list-include [<pattern>]
+                            List by a pattern
+      --list-exclude [<pattern>]
+                            List by a pattern
+      --module <module_name>
+                            The name of the module which will register the model
+                            in use.
+      --model <model_name>  The name of the model to play with random actions.
+      --runs <n>            The number of times to run the simulation.
+      --n-step <n>          The number of timesteps to run each episode.
+      --delay <ms>          The time in milliseconds to delay in each timestep to
+                            make simulation slower.
+      --no-action           The number of timesteps to run each episode.
 
 
 
 .. code-block:: bash
-  :caption: Running a model with random actions
+    :caption: Running a model with random actions
 
-  python -m digideep.environment.play --model "Pendulum-v0"
+    python -m digideep.environment.play --model "Pendulum-v0"
 
 .. code-block:: bash
-  :caption: Running a model with no actions
+    :caption: Running a model with no actions
 
-  python -m digideep.environment.play --model "Pendulum-v0" --no-action
+    python -m digideep.environment.play --model "Pendulum-v0" --no-action
 
 .. code-block:: bash
-  :caption: Running a model from another module (your custom designed environment).
+    :caption: Running a model from another module (your custom designed environment).
 
-  python -m digideep.environment.play --model "<model-name>" --module "<module-name>"
+    python -m digideep.environment.play --model "<model-name>" --module "<module-name>"
 
 .. code-block:: bash
-  :caption: List registered modules
+    :caption: List registered modules
 
-  python -m digideep.environment.play --list-include ".*"
-  python -m digideep.environment.play --list-include ".*Humanoid.*"
-  python -m digideep.environment.play --list-include ".*Humanoid.*" --list-exclude "DM*"
+    python -m digideep.environment.play --list-include ".*"
+    python -m digideep.environment.play --list-include ".*Humanoid.*"
+    python -m digideep.environment.play --list-include ".*Humanoid.*" --list-exclude "DM*"

requirements.txt

@@ -1,4 +1,3 @@
 colorama>=0.4.1
 psutil>=5.5.1
 pyyaml>=3.13
-sphinxcontrib-programoutput>=0.13

setup.py

@@ -11,8 +11,7 @@
     python_requires='>=3.4.0',
     url="https://github.com/sharif1093/digideep",
     install_requires=[
-        "colorama>=0.4.1", "psutil>=5.5.1", "pyyaml>=3.13",
-        "sphinxcontrib-programoutput>=0.13"
+        "colorama>=0.4.1", "psutil>=5.5.1", "pyyaml>=3.13"
     ],
     # packages=setuptools.find_packages(),
     packages=['digideep'],