From 072717ee3c4971bd912865607f19a9a3439e876e Mon Sep 17 00:00:00 2001 From: Morten Lied Johansen Date: Tue, 7 Nov 2017 10:31:07 +0100 Subject: [PATCH] Updated documentation --- docs/source/developer.rst | 2 +- docs/source/modules/k8s.models.configmap.rst | 7 +++++++ docs/source/modules/k8s.models.resourcequota.rst | 7 +++++++ docs/source/modules/k8s.models.rst | 2 ++ 4 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/source/modules/k8s.models.configmap.rst create mode 100644 docs/source/modules/k8s.models.resourcequota.rst diff --git a/docs/source/developer.rst b/docs/source/developer.rst index 0718ce7..50c69ec 100644 --- a/docs/source/developer.rst +++ b/docs/source/developer.rst @@ -42,7 +42,7 @@ Use this class... ...when The :py:class:`~k8s.fields.Field` class takes three parameters: type - The type of value this field contains. Can be simple types (int, bool etc), or subclasses of :py:class:`~k8s.base.Model`. + The type of value this field contains. Can be simple types (int, bool etc), :py:class:`datetime.datetime` or subclasses of :py:class:`~k8s.base.Model`. default_value The field is set to this value when an instance of the class is created. The default default is ``None``. diff --git a/docs/source/modules/k8s.models.configmap.rst b/docs/source/modules/k8s.models.configmap.rst new file mode 100644 index 0000000..4b341dc --- /dev/null +++ b/docs/source/modules/k8s.models.configmap.rst @@ -0,0 +1,7 @@ +k8s\.models\.configmap module +============================= + +.. automodule:: k8s.models.configmap + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/k8s.models.resourcequota.rst b/docs/source/modules/k8s.models.resourcequota.rst new file mode 100644 index 0000000..0fc0dbf --- /dev/null +++ b/docs/source/modules/k8s.models.resourcequota.rst @@ -0,0 +1,7 @@ +k8s\.models\.resourcequota module +================================= + +.. automodule:: k8s.models.resourcequota + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/k8s.models.rst b/docs/source/modules/k8s.models.rst index 8dc6a28..a251348 100644 --- a/docs/source/modules/k8s.models.rst +++ b/docs/source/modules/k8s.models.rst @@ -13,10 +13,12 @@ Submodules k8s.models.autoscaler k8s.models.common + k8s.models.configmap k8s.models.deployment k8s.models.ingress k8s.models.pod k8s.models.replication_controller + k8s.models.resourcequota k8s.models.service k8s.models.third_party_resource