Skip to content

Commit bbe532d

Browse files
Toni-SMToni-SM
authored
Docs update (#228)
* Update docs configuration * Remove __init__ automethod entry in docs
1 parent 4db2956 commit bbe532d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+7
-189
lines changed

‎docs/source/api/agents.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,6 @@ API (PyTorch)
119119
:private-members: _update, _empty_preprocessor, _get_internal_value
120120
:members:
121121

122-
.. automethod:: __init__
123122
.. automethod:: __str__
124123

125124
.. raw:: html
@@ -136,5 +135,4 @@ API (JAX)
136135
:private-members: _update, _empty_preprocessor, _get_internal_value
137136
:members:
138137

139-
.. automethod:: __init__
140138
.. automethod:: __str__

‎docs/source/api/agents/a2c.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -252,16 +252,12 @@ API (PyTorch)
252252
:private-members: _update
253253
:members:
254254

255-
.. automethod:: __init__
256-
257255
.. autoclass:: skrl.agents.torch.a2c.A2C_RNN
258256
:undoc-members:
259257
:show-inheritance:
260258
:private-members: _update
261259
:members:
262260

263-
.. automethod:: __init__
264-
265261
.. raw:: html
266262

267263
<br>
@@ -276,5 +272,3 @@ API (JAX)
276272
:show-inheritance:
277273
:private-members: _update
278274
:members:
279-
280-
.. automethod:: __init__

‎docs/source/api/agents/amp.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,5 +256,3 @@ API (PyTorch)
256256
:show-inheritance:
257257
:private-members: _update
258258
:members:
259-
260-
.. automethod:: __init__

‎docs/source/api/agents/cem.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,8 +195,6 @@ API (PyTorch)
195195
:private-members: _update
196196
:members:
197197

198-
.. automethod:: __init__
199-
200198
.. raw:: html
201199

202200
<br>
@@ -211,5 +209,3 @@ API (JAX)
211209
:show-inheritance:
212210
:private-members: _update
213211
:members:
214-
215-
.. automethod:: __init__

‎docs/source/api/agents/ddpg.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -256,16 +256,12 @@ API (PyTorch)
256256
:private-members: _update
257257
:members:
258258

259-
.. automethod:: __init__
260-
261259
.. autoclass:: skrl.agents.torch.ddpg.DDPG_RNN
262260
:undoc-members:
263261
:show-inheritance:
264262
:private-members: _update
265263
:members:
266264

267-
.. automethod:: __init__
268-
269265
.. raw:: html
270266

271267
<br>
@@ -280,5 +276,3 @@ API (JAX)
280276
:show-inheritance:
281277
:private-members: _update
282278
:members:
283-
284-
.. automethod:: __init__

‎docs/source/api/agents/ddqn.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,6 @@ API (PyTorch)
204204
:private-members: _update
205205
:members:
206206

207-
.. automethod:: __init__
208-
209207
.. raw:: html
210208

211209
<br>
@@ -220,5 +218,3 @@ API (JAX)
220218
:show-inheritance:
221219
:private-members: _update
222220
:members:
223-
224-
.. automethod:: __init__

‎docs/source/api/agents/dqn.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,6 @@ API (PyTorch)
204204
:private-members: _update
205205
:members:
206206

207-
.. automethod:: __init__
208-
209207
.. raw:: html
210208

211209
<br>
@@ -220,5 +218,3 @@ API (JAX)
220218
:show-inheritance:
221219
:private-members: _update
222220
:members:
223-
224-
.. automethod:: __init__

‎docs/source/api/agents/ppo.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -268,16 +268,12 @@ API (PyTorch)
268268
:private-members: _update
269269
:members:
270270

271-
.. automethod:: __init__
272-
273271
.. autoclass:: skrl.agents.torch.ppo.PPO_RNN
274272
:undoc-members:
275273
:show-inheritance:
276274
:private-members: _update
277275
:members:
278276

279-
.. automethod:: __init__
280-
281277
.. raw:: html
282278

283279
<br>
@@ -292,5 +288,3 @@ API (JAX)
292288
:show-inheritance:
293289
:private-members: _update
294290
:members:
295-
296-
.. automethod:: __init__

‎docs/source/api/agents/q_learning.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,5 +148,3 @@ API (PyTorch)
148148
:show-inheritance:
149149
:private-members: _update
150150
:members:
151-
152-
.. automethod:: __init__

‎docs/source/api/agents/rpo.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -305,16 +305,12 @@ API (PyTorch)
305305
:private-members: _update
306306
:members:
307307

308-
.. automethod:: __init__
309-
310308
.. autoclass:: skrl.agents.torch.rpo.RPO_RNN
311309
:undoc-members:
312310
:show-inheritance:
313311
:private-members: _update
314312
:members:
315313

316-
.. automethod:: __init__
317-
318314
.. raw:: html
319315

320316
<br>
@@ -329,5 +325,3 @@ API (JAX)
329325
:show-inheritance:
330326
:private-members: _update
331327
:members:
332-
333-
.. automethod:: __init__

0 commit comments

Comments
 (0)