Initial docs setup (#15)

* #14 initial docs setup

* remove some boilerplate

* fix syspath and incl. README

* readthedocs requirements

.gitignore

@@ -8,3 +8,4 @@ dist/
 .cache/
 .pytest_cache/
 .tox/
+docs/_build

Pipfile

@@ -14,6 +14,8 @@ tox = "*"
 coverage = "*"
 twine = "*"
 responses = "*"
+sphinx = "*"
+sphinx-rtd-theme = "*"
 
 [requires]
 python_version = "3.7"

README.rst

@@ -17,7 +17,7 @@ pykube-ng
 .. image:: https://img.shields.io/badge/license-apache-blue.svg
    :target:  https://pypi.python.org/pypi/pykube-ng/
 
-Python client library for Kubernetes.
+Pykube (pykube-ng) is a lightweight Python 3+ client library for Kubernetes.
 
 This is a fork of `kelproject/pykube <https://github.com/kelproject/pykube>`_ which is no longer maintained (archived). Here the original text of the pykube README:
 

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api/modules.rst

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

docs/api/pykube.rst

@@ -0,0 +1,72 @@
+.. _pykube-package:
+
+pykube package
+==============
+
+Submodules
+----------
+
+pykube.config module
+--------------------
+
+.. automodule:: pykube.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pykube.exceptions module
+------------------------
+
+.. automodule:: pykube.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pykube.http module
+------------------
+
+.. automodule:: pykube.http
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pykube.mixins module
+--------------------
+
+.. automodule:: pykube.mixins
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pykube.objects module
+---------------------
+
+.. automodule:: pykube.objects
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pykube.query module
+-------------------
+
+.. automodule:: pykube.query
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pykube.utils module
+-------------------
+
+.. automodule:: pykube.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pykube
+    :members:
+    :undoc-members:
+    :show-inheritance: