Skip to content

doc: Add missing models and groups to documentation #383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lgarber-akamai merged 2 commits into from
Mar 18, 2024
Merged

doc: Add missing models and groups to documentation #383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b870169
Include missing models and groups
lgarber-akamai Mar 14, 2024
7dac6b3
Update copyright
lgarber-akamai Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
# -- Project information -----------------------------------------------------

project = 'linode_api4'
copyright = '2023, Linode'
copyright = '2024, Akamai Technologies Inc.'
author = 'Linode'

# The short X.Y version
Expand Down
20 changes: 19 additions & 1 deletion docs/linode_api4/linode_client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ Includes methods for managing your account.
:members:
:special-members:

BetaGroup
^^^^^^^^^

Includes methods for enrolling in beta programs.

.. autoclass:: linode_api4.linode_client.BetaGroup
:members:
:special-members:

DatabaseGroup
^^^^^^^^^^^^^

Expand Down Expand Up @@ -98,7 +107,7 @@ accessing and working with associated features.
:members:
:special-members:

LKE Group
LKEGroup
^^^^^^^^^

Includes methods for interacting with Linode Kubernetes Engine.
Expand Down Expand Up @@ -199,3 +208,12 @@ Includes methods for managing Linode Volumes.
.. autoclass:: linode_api4.linode_client.VolumeGroup
:members:
:special-members:

VPCGroup
^^^^^^^^

Includes methods for managing Linode VPCs.

.. autoclass:: linode_api4.linode_client.VPCGroup
:members:
:special-members:
18 changes: 18 additions & 0 deletions docs/linode_api4/objects/models.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@ Account Models
:undoc-members:
:inherited-members:

Beta Models
-----------

.. automodule:: linode_api4.objects.beta
:members:
:exclude-members: api_endpoint, properties, derived_url_path, id_attribute, parent_id_name
:undoc-members:
:inherited-members:

Database Models
-------------

Expand Down Expand Up @@ -139,3 +148,12 @@ Volume Models
:exclude-members: api_endpoint, properties, derived_url_path, id_attribute, parent_id_name
:undoc-members:
:inherited-members:

VPC Models
----------

.. automodule:: linode_api4.objects.vpc
:members:
:exclude-members: api_endpoint, properties, derived_url_path, id_attribute, parent_id_name
:undoc-members:
:inherited-members: