Initial cut at documentation

doc/source/conf.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import sys
+
+from recommonmark.parser import CommonMarkParser
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
+source_suffix = ['.rst', '.md']
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    #'sphinx.ext.intersphinx',
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'kubernetes-python-client'
+copyright = u'2017, Kubernetes'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     u'%s Documentation' % project,
+     u'Kubernetes', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

doc/source/contributing.rst

@@ -0,0 +1,4 @@
+============
+Contributing
+============
+.. include:: ../../CONTRIBUTING.md

doc/source/index.rst

@@ -0,0 +1,26 @@
+.. kubernetes-python-client documentation master file, created by
+   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to kubernetes-python-client's documentation!
+========================================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   installation
+   usage
+   modules
+   contributing
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/source/installation.rst

@@ -0,0 +1,12 @@
+============
+Installation
+============
+
+At the command line::
+
+    $ pip install kubernetes
+
+Or, if you have virtualenvwrapper installed::
+
+    $ mkvirtualenv kubernetes
+    $ pip install kubernetes

doc/source/kubernetes.client.apis.rst

@@ -0,0 +1,222 @@
+kubernetes.client.apis package
+==============================
+
+Submodules
+----------
+
+kubernetes.client.apis.apis_api module
+--------------------------------------
+
+.. automodule:: kubernetes.client.apis.apis_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.apps_api module
+--------------------------------------
+
+.. automodule:: kubernetes.client.apis.apps_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.apps_v1beta1_api module
+----------------------------------------------
+
+.. automodule:: kubernetes.client.apis.apps_v1beta1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.authentication_api module
+------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.authentication_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.authentication_v1beta1_api module
+--------------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.authentication_v1beta1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.authorization_api module
+-----------------------------------------------
+
+.. automodule:: kubernetes.client.apis.authorization_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.authorization_v1beta1_api module
+-------------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.authorization_v1beta1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.autoscaling_api module
+---------------------------------------------
+
+.. automodule:: kubernetes.client.apis.autoscaling_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.autoscaling_v1_api module
+------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.autoscaling_v1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.batch_api module
+---------------------------------------
+
+.. automodule:: kubernetes.client.apis.batch_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.batch_v1_api module
+------------------------------------------
+
+.. automodule:: kubernetes.client.apis.batch_v1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.batch_v2alpha1_api module
+------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.batch_v2alpha1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.certificates_api module
+----------------------------------------------
+
+.. automodule:: kubernetes.client.apis.certificates_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.certificates_v1alpha1_api module
+-------------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.certificates_v1alpha1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.core_api module
+--------------------------------------
+
+.. automodule:: kubernetes.client.apis.core_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.core_v1_api module
+-----------------------------------------
+
+.. automodule:: kubernetes.client.apis.core_v1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.extensions_api module
+--------------------------------------------
+
+.. automodule:: kubernetes.client.apis.extensions_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.extensions_v1beta1_api module
+----------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.extensions_v1beta1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.logs_api module
+--------------------------------------
+
+.. automodule:: kubernetes.client.apis.logs_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.policy_api module
+----------------------------------------
+
+.. automodule:: kubernetes.client.apis.policy_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.policy_v1beta1_api module
+------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.policy_v1beta1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.rbac_authorization_api module
+----------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.rbac_authorization_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.rbac_authorization_v1alpha1_api module
+-------------------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.rbac_authorization_v1alpha1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.storage_api module
+-----------------------------------------
+
+.. automodule:: kubernetes.client.apis.storage_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.storage_v1beta1_api module
+-------------------------------------------------
+
+.. automodule:: kubernetes.client.apis.storage_v1beta1_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.apis.version_api module
+-----------------------------------------
+
+.. automodule:: kubernetes.client.apis.version_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: kubernetes.client.apis
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/kubernetes.client.rst

@@ -0,0 +1,46 @@
+kubernetes.client package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    kubernetes.client.apis
+    kubernetes.client.models
+
+Submodules
+----------
+
+kubernetes.client.api_client module
+-----------------------------------
+
+.. automodule:: kubernetes.client.api_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.configuration module
+--------------------------------------
+
+.. automodule:: kubernetes.client.configuration
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.client.rest module
+-----------------------------
+
+.. automodule:: kubernetes.client.rest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: kubernetes.client
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/kubernetes.config.rst

@@ -0,0 +1,54 @@
+kubernetes.config package
+=========================
+
+Submodules
+----------
+
+kubernetes.config.config_exception module
+-----------------------------------------
+
+.. automodule:: kubernetes.config.config_exception
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.config.incluster_config module
+-----------------------------------------
+
+.. automodule:: kubernetes.config.incluster_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.config.incluster_config_test module
+----------------------------------------------
+
+.. automodule:: kubernetes.config.incluster_config_test
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.config.kube_config module
+------------------------------------
+
+.. automodule:: kubernetes.config.kube_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.config.kube_config_test module
+-----------------------------------------
+
+.. automodule:: kubernetes.config.kube_config_test
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: kubernetes.config
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/kubernetes.rst

@@ -0,0 +1,20 @@
+kubernetes package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    kubernetes.client
+    kubernetes.config
+    kubernetes.test
+    kubernetes.watch
+
+Module contents
+---------------
+
+.. automodule:: kubernetes
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/kubernetes.watch.rst

@@ -0,0 +1,30 @@
+kubernetes.watch package
+========================
+
+Submodules
+----------
+
+kubernetes.watch.watch module
+-----------------------------
+
+.. automodule:: kubernetes.watch.watch
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+kubernetes.watch.watch_test module
+----------------------------------
+
+.. automodule:: kubernetes.watch.watch_test
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: kubernetes.watch
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/modules.rst

@@ -0,0 +1,7 @@
+kubernetes
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   kubernetes

doc/source/readme.rst

@@ -0,0 +1,4 @@
+======
+Readme
+======
+.. include:: ../../README.md

doc/source/usage.rst

@@ -0,0 +1,7 @@
+========
+Usage
+========
+
+To use kubernetes-python-client in a project::
+
+    import kubernetes

setup.cfg

@@ -0,0 +1,7 @@
+[build_sphinx]
+source-dir = doc/source
+build-dir = doc/build
+all_files = 1
+
+[upload_sphinx]
+upload-dir = doc/build/html

test-requirements.txt

@@ -4,3 +4,5 @@ pluggy>=0.3.1
 py>=1.4.31
 randomize>=0.13
 mock>=2.0.0
+sphinx>=1.2.1,!=1.3b1,<1.4 # BSD
+recommonmark

tox.ini

@@ -1,6 +1,9 @@
 [tox]
 envlist = py27, py34, py35
 
+[testenv:docs]
+commands = python setup.py build_sphinx
+
 [testenv]
 deps=-r{toxinidir}/requirements.txt
      -r{toxinidir}/test-requirements.txt