Skip to content

Commit 0ca9210

Browse files
dimsdims
committed
Initial cut at documentation
1 parent 3220a96 commit 0ca9210

17 files changed

+4890
-0
lines changed

Diff for: ‎doc/source/conf.py

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# -*- coding: utf-8 -*-
2+
# Licensed under the Apache License, Version 2.0 (the "License");
3+
# you may not use this file except in compliance with the License.
4+
# You may obtain a copy of the License at
5+
#
6+
# http://www.apache.org/licenses/LICENSE-2.0
7+
#
8+
# Unless required by applicable law or agreed to in writing, software
9+
# distributed under the License is distributed on an "AS IS" BASIS,
10+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11+
# implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
import os
16+
import sys
17+
18+
from recommonmark.parser import CommonMarkParser
19+
20+
sys.path.insert(0, os.path.abspath('../..'))
21+
# -- General configuration ----------------------------------------------------
22+
23+
source_parsers = {
24+
'.md': CommonMarkParser,
25+
}
26+
27+
source_suffix = ['.rst', '.md']
28+
29+
# Add any Sphinx extension module names here, as strings. They can be
30+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31+
extensions = [
32+
'sphinx.ext.autodoc',
33+
#'sphinx.ext.intersphinx',
34+
]
35+
36+
# autodoc generation is a bit aggressive and a nuisance when doing heavy
37+
# text edit cycles.
38+
# execute "export SPHINX_DEBUG=1" in your terminal to disable
39+
40+
# The suffix of source filenames.
41+
source_suffix = '.rst'
42+
43+
# The master toctree document.
44+
master_doc = 'index'
45+
46+
# General information about the project.
47+
project = u'kubernetes-python-client'
48+
copyright = u'2017, Kubernetes'
49+
50+
# If true, '()' will be appended to :func: etc. cross-reference text.
51+
add_function_parentheses = True
52+
53+
# If true, the current module name will be prepended to all description
54+
# unit titles (such as .. function::).
55+
add_module_names = True
56+
57+
# The name of the Pygments (syntax highlighting) style to use.
58+
pygments_style = 'sphinx'
59+
60+
# -- Options for HTML output --------------------------------------------------
61+
62+
# The theme to use for HTML and HTML Help pages. Major themes that come with
63+
# Sphinx are currently 'default' and 'sphinxdoc'.
64+
# html_theme_path = ["."]
65+
# html_theme = '_theme'
66+
# html_static_path = ['static']
67+
68+
# Output file base name for HTML help builder.
69+
htmlhelp_basename = '%sdoc' % project
70+
71+
# Grouping the document tree into LaTeX files. List of tuples
72+
# (source start file, target name, title, author, documentclass
73+
# [howto/manual]).
74+
latex_documents = [
75+
('index',
76+
'%s.tex' % project,
77+
u'%s Documentation' % project,
78+
u'Kubernetes', 'manual'),
79+
]
80+
81+
# Example configuration for intersphinx: refer to the Python standard library.
82+
#intersphinx_mapping = {'http://docs.python.org/': None}

Diff for: ‎doc/source/contributing.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
============
2+
Contributing
3+
============
4+
.. include:: ../../CONTRIBUTING.md

Diff for: ‎doc/source/index.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. kubernetes-python-client documentation master file, created by
2+
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to kubernetes-python-client's documentation!
7+
========================================================
8+
9+
Contents:
10+
11+
.. toctree::
12+
:maxdepth: 2
13+
14+
readme
15+
installation
16+
usage
17+
modules
18+
contributing
19+
20+
Indices and tables
21+
==================
22+
23+
* :ref:`genindex`
24+
* :ref:`modindex`
25+
* :ref:`search`
26+

Diff for: ‎doc/source/installation.rst

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
============
2+
Installation
3+
============
4+
5+
At the command line::
6+
7+
$ pip install kubernetes
8+
9+
Or, if you have virtualenvwrapper installed::
10+
11+
$ mkvirtualenv kubernetes
12+
$ pip install kubernetes

Diff for: ‎doc/source/kubernetes.client.apis.rst

+222
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
kubernetes.client.apis package
2+
==============================
3+
4+
Submodules
5+
----------
6+
7+
kubernetes.client.apis.apis_api module
8+
--------------------------------------
9+
10+
.. automodule:: kubernetes.client.apis.apis_api
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
kubernetes.client.apis.apps_api module
16+
--------------------------------------
17+
18+
.. automodule:: kubernetes.client.apis.apps_api
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
kubernetes.client.apis.apps_v1beta1_api module
24+
----------------------------------------------
25+
26+
.. automodule:: kubernetes.client.apis.apps_v1beta1_api
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
kubernetes.client.apis.authentication_api module
32+
------------------------------------------------
33+
34+
.. automodule:: kubernetes.client.apis.authentication_api
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
kubernetes.client.apis.authentication_v1beta1_api module
40+
--------------------------------------------------------
41+
42+
.. automodule:: kubernetes.client.apis.authentication_v1beta1_api
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
kubernetes.client.apis.authorization_api module
48+
-----------------------------------------------
49+
50+
.. automodule:: kubernetes.client.apis.authorization_api
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
kubernetes.client.apis.authorization_v1beta1_api module
56+
-------------------------------------------------------
57+
58+
.. automodule:: kubernetes.client.apis.authorization_v1beta1_api
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
kubernetes.client.apis.autoscaling_api module
64+
---------------------------------------------
65+
66+
.. automodule:: kubernetes.client.apis.autoscaling_api
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
kubernetes.client.apis.autoscaling_v1_api module
72+
------------------------------------------------
73+
74+
.. automodule:: kubernetes.client.apis.autoscaling_v1_api
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
kubernetes.client.apis.batch_api module
80+
---------------------------------------
81+
82+
.. automodule:: kubernetes.client.apis.batch_api
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
kubernetes.client.apis.batch_v1_api module
88+
------------------------------------------
89+
90+
.. automodule:: kubernetes.client.apis.batch_v1_api
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
94+
95+
kubernetes.client.apis.batch_v2alpha1_api module
96+
------------------------------------------------
97+
98+
.. automodule:: kubernetes.client.apis.batch_v2alpha1_api
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:
102+
103+
kubernetes.client.apis.certificates_api module
104+
----------------------------------------------
105+
106+
.. automodule:: kubernetes.client.apis.certificates_api
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:
110+
111+
kubernetes.client.apis.certificates_v1alpha1_api module
112+
-------------------------------------------------------
113+
114+
.. automodule:: kubernetes.client.apis.certificates_v1alpha1_api
115+
:members:
116+
:undoc-members:
117+
:show-inheritance:
118+
119+
kubernetes.client.apis.core_api module
120+
--------------------------------------
121+
122+
.. automodule:: kubernetes.client.apis.core_api
123+
:members:
124+
:undoc-members:
125+
:show-inheritance:
126+
127+
kubernetes.client.apis.core_v1_api module
128+
-----------------------------------------
129+
130+
.. automodule:: kubernetes.client.apis.core_v1_api
131+
:members:
132+
:undoc-members:
133+
:show-inheritance:
134+
135+
kubernetes.client.apis.extensions_api module
136+
--------------------------------------------
137+
138+
.. automodule:: kubernetes.client.apis.extensions_api
139+
:members:
140+
:undoc-members:
141+
:show-inheritance:
142+
143+
kubernetes.client.apis.extensions_v1beta1_api module
144+
----------------------------------------------------
145+
146+
.. automodule:: kubernetes.client.apis.extensions_v1beta1_api
147+
:members:
148+
:undoc-members:
149+
:show-inheritance:
150+
151+
kubernetes.client.apis.logs_api module
152+
--------------------------------------
153+
154+
.. automodule:: kubernetes.client.apis.logs_api
155+
:members:
156+
:undoc-members:
157+
:show-inheritance:
158+
159+
kubernetes.client.apis.policy_api module
160+
----------------------------------------
161+
162+
.. automodule:: kubernetes.client.apis.policy_api
163+
:members:
164+
:undoc-members:
165+
:show-inheritance:
166+
167+
kubernetes.client.apis.policy_v1beta1_api module
168+
------------------------------------------------
169+
170+
.. automodule:: kubernetes.client.apis.policy_v1beta1_api
171+
:members:
172+
:undoc-members:
173+
:show-inheritance:
174+
175+
kubernetes.client.apis.rbac_authorization_api module
176+
----------------------------------------------------
177+
178+
.. automodule:: kubernetes.client.apis.rbac_authorization_api
179+
:members:
180+
:undoc-members:
181+
:show-inheritance:
182+
183+
kubernetes.client.apis.rbac_authorization_v1alpha1_api module
184+
-------------------------------------------------------------
185+
186+
.. automodule:: kubernetes.client.apis.rbac_authorization_v1alpha1_api
187+
:members:
188+
:undoc-members:
189+
:show-inheritance:
190+
191+
kubernetes.client.apis.storage_api module
192+
-----------------------------------------
193+
194+
.. automodule:: kubernetes.client.apis.storage_api
195+
:members:
196+
:undoc-members:
197+
:show-inheritance:
198+
199+
kubernetes.client.apis.storage_v1beta1_api module
200+
-------------------------------------------------
201+
202+
.. automodule:: kubernetes.client.apis.storage_v1beta1_api
203+
:members:
204+
:undoc-members:
205+
:show-inheritance:
206+
207+
kubernetes.client.apis.version_api module
208+
-----------------------------------------
209+
210+
.. automodule:: kubernetes.client.apis.version_api
211+
:members:
212+
:undoc-members:
213+
:show-inheritance:
214+
215+
216+
Module contents
217+
---------------
218+
219+
.. automodule:: kubernetes.client.apis
220+
:members:
221+
:undoc-members:
222+
:show-inheritance:

0 commit comments

Comments
 (0)