Remove __init__ automethod entry in docs

Toni-SM · Nov 23, 2024 · fc9a3e6 · fc9a3e6
1 parent e1e1573
commit fc9a3e6
Show file tree

Hide file tree

Showing 41 changed files with 3 additions and 188 deletions.
diff --git a/docs/source/api/agents.rst b/docs/source/api/agents.rst
@@ -119,7 +119,6 @@ API (PyTorch)
     :private-members: _update, _empty_preprocessor, _get_internal_value
     :members:
 
-    .. automethod:: __init__
     .. automethod:: __str__
 
 .. raw:: html
@@ -136,5 +135,4 @@ API (JAX)
     :private-members: _update, _empty_preprocessor, _get_internal_value
     :members:
 
-    .. automethod:: __init__
     .. automethod:: __str__
diff --git a/docs/source/api/agents/a2c.rst b/docs/source/api/agents/a2c.rst
@@ -252,16 +252,12 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.agents.torch.a2c.A2C_RNN
     :undoc-members:
     :show-inheritance:
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -276,5 +272,3 @@ API (JAX)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/amp.rst b/docs/source/api/agents/amp.rst
@@ -256,5 +256,3 @@ API (PyTorch)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/cem.rst b/docs/source/api/agents/cem.rst
@@ -195,8 +195,6 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -211,5 +209,3 @@ API (JAX)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/ddpg.rst b/docs/source/api/agents/ddpg.rst
@@ -256,16 +256,12 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.agents.torch.ddpg.DDPG_RNN
     :undoc-members:
     :show-inheritance:
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -280,5 +276,3 @@ API (JAX)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/ddqn.rst b/docs/source/api/agents/ddqn.rst
@@ -204,8 +204,6 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -220,5 +218,3 @@ API (JAX)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/dqn.rst b/docs/source/api/agents/dqn.rst
@@ -204,8 +204,6 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -220,5 +218,3 @@ API (JAX)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/ppo.rst b/docs/source/api/agents/ppo.rst
@@ -268,16 +268,12 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.agents.torch.ppo.PPO_RNN
     :undoc-members:
     :show-inheritance:
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -292,5 +288,3 @@ API (JAX)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/q_learning.rst b/docs/source/api/agents/q_learning.rst
@@ -148,5 +148,3 @@ API (PyTorch)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/rpo.rst b/docs/source/api/agents/rpo.rst
@@ -305,16 +305,12 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.agents.torch.rpo.RPO_RNN
     :undoc-members:
     :show-inheritance:
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -329,5 +325,3 @@ API (JAX)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/sac.rst b/docs/source/api/agents/sac.rst
@@ -264,17 +264,12 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
-
 .. autoclass:: skrl.agents.torch.sac.SAC_RNN
     :undoc-members:
     :show-inheritance:
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -289,5 +284,3 @@ API (JAX)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/sarsa.rst b/docs/source/api/agents/sarsa.rst
@@ -148,5 +148,3 @@ API (PyTorch)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/td3.rst b/docs/source/api/agents/td3.rst
@@ -278,16 +278,12 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.agents.torch.td3.TD3_RNN
     :undoc-members:
     :show-inheritance:
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -302,5 +298,3 @@ API (JAX)
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/agents/trpo.rst b/docs/source/api/agents/trpo.rst
@@ -302,12 +302,8 @@ API (PyTorch)
     :private-members: _update
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.agents.torch.trpo.TRPO_RNN
     :undoc-members:
     :show-inheritance:
     :private-members: _update
     :members:
-
-    .. automethod:: __init__
diff --git a/docs/source/api/envs/multi_agents_wrapping.rst b/docs/source/api/envs/multi_agents_wrapping.rst
@@ -142,29 +142,21 @@ Internal API (PyTorch)
     :show-inheritance:
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.envs.wrappers.torch.IsaacLabMultiAgentWrapper
     :undoc-members:
     :show-inheritance:
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.envs.wrappers.torch.PettingZooWrapper
     :undoc-members:
     :show-inheritance:
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.envs.wrappers.torch.BiDexHandsWrapper
     :undoc-members:
     :show-inheritance:
     :members:
 
-    .. automethod:: __init__
-
 .. raw:: html
 
     <br>
@@ -177,25 +169,17 @@ Internal API (JAX)
     :show-inheritance:
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.envs.wrappers.jax.IsaacLabMultiAgentWrapper
     :undoc-members:
     :show-inheritance:
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.envs.wrappers.jax.PettingZooWrapper
     :undoc-members:
     :show-inheritance:
     :members:
 
-    .. automethod:: __init__
-
 .. autoclass:: skrl.envs.wrappers.jax.BiDexHandsWrapper
     :undoc-members:
     :show-inheritance:
     :members:
-
-    .. automethod:: __init__