Skip to content

Commit c9cdf90

Browse files
authored
Merge pull request #1346 from jasonrahm/enhancement.docs
Enhancement.docs
2 parents aae2e44 + cd5f369 commit c9cdf90

30 files changed

Lines changed: 763 additions & 36 deletions

docs/apidoc/f5.bigip.cm.rst

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ Module Contents
1313

1414
.. autosummary::
1515

16-
device
17-
device_group
18-
traffic_group
16+
system
1917

2018
Subpackages
2119
-----------
@@ -26,22 +24,10 @@ Subpackages
2624
Submodules
2725
----------
2826

29-
device
27+
system
3028
~~~~~~
3129

32-
.. automodule:: f5.bigip.cm.device
33-
:members:
34-
35-
device_group
36-
~~~~~~~~~~~~
37-
38-
.. automodule:: f5.bigip.cm.device_group
39-
:members:
40-
41-
traffic_group
42-
~~~~~~~~~~~~~
43-
44-
.. automodule:: f5.bigip.cm.traffic_group
30+
.. automodule:: f5.bigip.cm.system
4531
:members:
4632

4733
.. toctree::

docs/apidoc/f5.bigip.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ f5.bigip module
2929
resource.OrganizingCollection
3030
resource.Collection
3131
resource.Resource
32+
resource.UnnamedResource
33+
resource.AsmResource
34+
resource.AsmTaskResource
35+
resource.TaskResource
3236
resource.PathElement
3337

3438
Resource Exceptions
@@ -41,6 +45,7 @@ f5.bigip module
4145
resource.KindTypeMismatch
4246
resource.DeviceProvidesIncompatibleKey
4347
resource.InvalidResource
48+
resource.MissingRequiredCommandParameter
4449
resource.MissingRequiredCreationParameter
4550
resource.MissingRequiredReadParameter
4651
resource.UnregisteredKind
@@ -59,7 +64,13 @@ f5.bigip module
5964
mixins.ToDictMixin
6065
mixins.LazyAttributesMixin
6166
mixins.ExclusiveAttributesMixin
67+
mixins.CheckExistenceMixin
68+
mixins.CommandExecutionMixin
69+
mixins.DeviceMixin
70+
mixins.FileDownloadMixin
71+
mixins.FileUploadMixin
6272
mixins.UnnamedResourceMixin
73+
mixins.AsmFileMixin
6374
mixins.LazyAttributesRequired
6475

6576

docs/apidoc/f5.bigip.shared.rst

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,34 @@ Module Contents
1313

1414
.. autosummary::
1515

16-
bigip_failover_state
17-
licensing
16+
authn
17+
authz
18+
file_transfer
19+
iapp
1820

1921
Submodules
2022
----------
2123

22-
bigip_failover_state
23-
~~~~~~~~~~~~~~~~~~~~
24+
authn
25+
~~~~~
2426

25-
.. automodule:: f5.bigip.shared.bigip_failover_state
27+
.. automodule:: f5.bigip.shared.authn
2628
:members:
2729

28-
licensing
29-
~~~~~~~~~
30+
authz
31+
~~~~~
3032

31-
.. automodule:: f5.bigip.shared.licensing
33+
.. automodule:: f5.bigip.shared.authz
34+
:members:
35+
36+
file_transfer
37+
~~~~~~~~~~~~~
38+
39+
.. automodule:: f5.bigip.shared.file_transfer
40+
:members:
41+
42+
iapp
43+
~~~~
44+
45+
.. automodule:: f5.bigip.shared.iapp
3246
:members:

docs/apidoc/f5.bigip.tm.asm.rst

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
f5.bigip.tm.asm
2+
===============
3+
4+
Module contents
5+
---------------
6+
7+
.. automodule:: f5.bigip.tm.asm
8+
:members:
9+
10+
Submodule List
11+
~~~~~~~~~~~~~~
12+
.. py:currentmodule:: f5.bigip.tm.asm
13+
14+
.. autosummary::
15+
16+
attack_types
17+
file_transfer
18+
policy_templates
19+
signature_sets
20+
signature_statuses
21+
signature_update
22+
signatures
23+
tasks
24+
25+
26+
Submodules
27+
----------
28+
29+
attack_types
30+
~~~~~~~~~~~~
31+
32+
.. automodule:: f5.bigip.tm.asm.attack_types
33+
:members:
34+
35+
file_transfer
36+
~~~~~~~~~~~~~
37+
38+
.. automodule:: f5.bigip.tm.asm.file_transfer
39+
:members:
40+
41+
policy_templates
42+
~~~~~~~~~~~~~~~~
43+
44+
.. automodule:: f5.bigip.tm.asm.policy_templates
45+
:members:
46+
47+
signature_sets
48+
~~~~~~~~~~~~~~
49+
50+
.. automodule:: f5.bigip.tm.asm.signature_sets
51+
:members:
52+
53+
signature_statuses
54+
~~~~~~~~~~~~~~~~~~
55+
56+
.. automodule:: f5.bigip.tm.asm.signature_statuses
57+
:members:
58+
59+
signature_udpate
60+
~~~~~~~~~~~~~~~~
61+
62+
.. automodule:: f5.bigip.tm.asm.signature_update
63+
:members:
64+
65+
signatures
66+
~~~~~~~~~~
67+
68+
.. automodule:: f5.bigip.tm.asm.signatures
69+
:members:
70+
71+
tasks
72+
~~~~~
73+
74+
.. automodule:: f5.bigip.tm.asm.tasks
75+
:members:

docs/apidoc/f5.bigip.tm.auth.rst

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,82 @@ Module Contents
1313

1414
.. autosummary::
1515

16+
cert_ldap
17+
ldap
18+
partition
1619
password_policy
20+
radius
21+
radius_server
22+
remote_role
23+
remote_user
24+
source
25+
tacacs
1726
user
1827

28+
1929
Submodules
2030
----------
2131

32+
cert_ldap
33+
~~~~~~~~~
34+
35+
.. automodule:: f5.bigip.tm.auth.cert_ldap
36+
:members:
37+
38+
ldap
39+
~~~~
40+
41+
.. automodule:: f5.bigip.tm.auth.ldap
42+
:members:
43+
44+
partition
45+
~~~~~~~~~
46+
47+
.. automodule:: f5.bigip.tm.auth.partition
48+
:members:
49+
2250
password_policy
2351
~~~~~~~~~~~~~~~
2452

2553
.. automodule:: f5.bigip.tm.auth.password_policy
2654
:members:
2755

56+
radius
57+
~~~~~~
58+
59+
.. automodule:: f5.bigip.tm.auth.radius
60+
:members:
61+
62+
radius_server
63+
~~~~~~~~~~~~~
64+
65+
.. automodule:: f5.bigip.tm.auth.radius_server
66+
:members:
67+
68+
remote_role
69+
~~~~~~~~~~~
70+
71+
.. automodule:: f5.bigip.tm.auth.remote_role
72+
:members:
73+
74+
remote_user
75+
~~~~~~~~~~~
76+
77+
.. automodule:: f5.bigip.tm.auth.remote_user
78+
:members:
79+
80+
source
81+
~~~~~~
82+
83+
.. automodule:: f5.bigip.tm.auth.source
84+
:members:
85+
86+
tacacs
87+
~~~~~~
88+
89+
.. automodule:: f5.bigip.tm.auth.tacacs
90+
:members:
91+
2892
user
2993
~~~~
3094

docs/apidoc/f5.bigip.tm.gtm.rst

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,20 @@ Module contents
99

1010
Submodule List
1111
~~~~~~~~~~~~~~
12-
.. py:currentmodule:: f5.bigip.tm.gtm.
12+
.. py:currentmodule:: f5.bigip.tm.gtm
1313
1414
.. autosummary::
1515

1616
datacenter
17+
global_settings
18+
listener
19+
pool
20+
region
1721
rule
22+
server
23+
topology
24+
wideip
25+
1826

1927
Submodules
2028
----------
@@ -25,15 +33,50 @@ datacenter
2533
.. automodule:: f5.bigip.tm.gtm.datacenter
2634
:members:
2735

36+
global_settings
37+
~~~~~~~~~~~~~~~
38+
39+
.. automodule:: f5.bigip.tm.gtm.global_settings
40+
:members:
41+
42+
listener
43+
~~~~~~~~
44+
45+
.. automodule:: f5.bigip.tm.gtm.listener
46+
:members:
47+
48+
pool
49+
~~~~
50+
51+
.. automodule:: f5.bigip.tm.gtm.pool
52+
:members:
53+
54+
region
55+
~~~~~~
56+
57+
.. automodule:: f5.bigip.tm.gtm.region
58+
:members:
59+
2860
rule
2961
~~~~
3062

3163
.. automodule:: f5.bigip.tm.gtm.rule
3264
:members:
3365

66+
server
67+
~~~~~~
3468

69+
.. automodule:: f5.bigip.tm.gtm.server
70+
:members:
3571

72+
topology
73+
~~~~~~~~
3674

75+
.. automodule:: f5.bigip.tm.gtm.topology
76+
:members:
3777

78+
wideip
79+
~~~~~~
3880

39-
81+
.. automodule:: f5.bigip.tm.gtm.wideip
82+
:members:

0 commit comments

Comments
 (0)