From 2017e2e6b54e1525fb5a9d7ded1593d0f6edf80f Mon Sep 17 00:00:00 2001 From: Henning Jacobs Date: Mon, 4 Mar 2019 22:56:10 +0100 Subject: [PATCH 1/4] #14 initial docs setup --- .gitignore | 1 + Pipfile | 2 + Pipfile.lock | 134 +++++++++++++++++++++++++++----- README.rst | 2 +- docs/Makefile | 19 +++++ docs/api/modules.rst | 7 ++ docs/api/pykube.rst | 72 +++++++++++++++++ docs/conf.py | 178 +++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 57 ++++++++++++++ 9 files changed, 450 insertions(+), 22 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/api/modules.rst create mode 100644 docs/api/pykube.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/.gitignore b/.gitignore index 1a359cb..0503bdb 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ dist/ .cache/ .pytest_cache/ .tox/ +docs/_build diff --git a/Pipfile b/Pipfile index 099c57a..d4d9e3b 100644 --- a/Pipfile +++ b/Pipfile @@ -14,6 +14,8 @@ tox = "*" coverage = "*" twine = "*" responses = "*" +sphinx = "*" +sphinx-rtd-theme = "*" [requires] python_version = "3.7" diff --git a/Pipfile.lock b/Pipfile.lock index e49761b..58e6622 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "fa3c25be3741db0d58d003802ae34a8f5ee3dcb71275bf08e43883dd34e67902" + "sha256": "ed47cd06eaf84f6e12b990dedd3f7078917563ecf8b8846e1c0ca78553a0db66" }, "pipfile-spec": 6, "requires": { @@ -41,13 +41,6 @@ "editable": true, "path": "." }, - "pytz": { - "hashes": [ - "sha256:32b0891edff07e28efe91284ed9c31e123d84bea3fd98e1f72be2508f43ef8d9", - "sha256:d5f05e487007e29e03409f9398d074e158d920d36eb82eaf66fb1136b0c5374c" - ], - "version": "==2018.9" - }, "pyyaml": { "hashes": [ "sha256:3d7da3009c0f3e783b2c873687652d83b1bbfd5c88e9813fb7e5b03c0dd3108b", @@ -71,19 +64,6 @@ ], "version": "==2.21.0" }, - "six": { - "hashes": [ - "sha256:3350809f0555b11f552448330d0b52d5f24c91a322ea4a15ef22629740f3761c", - "sha256:d16a0141ec1a18405cd4ce8b4613101da75da0e9a7aec5bdd4fa804d0e0eba73" - ], - "version": "==1.12.0" - }, - "tzlocal": { - "hashes": [ - "sha256:4ebeb848845ac898da6519b9b31879cf13b6626f7184c496037b818e238f2c4e" - ], - "version": "==1.5.1" - }, "urllib3": { "hashes": [ "sha256:61bf29cada3fc2fbefad4fdf059ea4bd1b4a86d2b6d15e1c7c0b582b9752fe39", @@ -93,6 +73,13 @@ } }, "develop": { + "alabaster": { + "hashes": [ + "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359", + "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02" + ], + "version": "==0.7.12" + }, "atomicwrites": { "hashes": [ "sha256:03472c30eb2c5d1ba9227e4c2ca66ab8287fbfbbda3888aa93dc2e28fc6811b4", @@ -107,6 +94,13 @@ ], "version": "==19.1.0" }, + "babel": { + "hashes": [ + "sha256:6778d85147d5d85345c14a26aada5e478ab04e39b078b0745ee6870c2b5cf669", + "sha256:8cba50f48c529ca3fa18cf81fa9403be176d374ac4d60738b839122dfaaa3d23" + ], + "version": "==2.6.0" + }, "bleach": { "hashes": [ "sha256:213336e49e102af26d9cde77dd2d0397afabc5a6bf2fed985dc35b5d1e285a16", @@ -226,6 +220,53 @@ ], "version": "==2.8" }, + "imagesize": { + "hashes": [ + "sha256:3f349de3eb99145973fefb7dbe38554414e5c30abd0c8e4b970a7c9d09f3a1d8", + "sha256:f3832918bc3c66617f92e35f5d70729187676313caa60c187eb0f28b8fe5e3b5" + ], + "version": "==1.1.0" + }, + "jinja2": { + "hashes": [ + "sha256:74c935a1b8bb9a3947c50a54766a969d4846290e1e788ea44c1392163723c3bd", + "sha256:f84be1bb0040caca4cea721fcbbbbd61f9be9464ca236387158b0feea01914a4" + ], + "version": "==2.10" + }, + "markupsafe": { + "hashes": [ + "sha256:00bc623926325b26bb9605ae9eae8a215691f33cae5df11ca5424f06f2d1f473", + "sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161", + "sha256:09c4b7f37d6c648cb13f9230d847adf22f8171b1ccc4d5682398e77f40309235", + "sha256:1027c282dad077d0bae18be6794e6b6b8c91d58ed8a8d89a89d59693b9131db5", + "sha256:24982cc2533820871eba85ba648cd53d8623687ff11cbb805be4ff7b4c971aff", + "sha256:29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b", + "sha256:43a55c2930bbc139570ac2452adf3d70cdbb3cfe5912c71cdce1c2c6bbd9c5d1", + "sha256:46c99d2de99945ec5cb54f23c8cd5689f6d7177305ebff350a58ce5f8de1669e", + "sha256:500d4957e52ddc3351cabf489e79c91c17f6e0899158447047588650b5e69183", + "sha256:535f6fc4d397c1563d08b88e485c3496cf5784e927af890fb3c3aac7f933ec66", + "sha256:62fe6c95e3ec8a7fad637b7f3d372c15ec1caa01ab47926cfdf7a75b40e0eac1", + "sha256:6dd73240d2af64df90aa7c4e7481e23825ea70af4b4922f8ede5b9e35f78a3b1", + "sha256:717ba8fe3ae9cc0006d7c451f0bb265ee07739daf76355d06366154ee68d221e", + "sha256:79855e1c5b8da654cf486b830bd42c06e8780cea587384cf6545b7d9ac013a0b", + "sha256:7c1699dfe0cf8ff607dbdcc1e9b9af1755371f92a68f706051cc8c37d447c905", + "sha256:88e5fcfb52ee7b911e8bb6d6aa2fd21fbecc674eadd44118a9cc3863f938e735", + "sha256:8defac2f2ccd6805ebf65f5eeb132adcf2ab57aa11fdf4c0dd5169a004710e7d", + "sha256:98c7086708b163d425c67c7a91bad6e466bb99d797aa64f965e9d25c12111a5e", + "sha256:9add70b36c5666a2ed02b43b335fe19002ee5235efd4b8a89bfcf9005bebac0d", + "sha256:9bf40443012702a1d2070043cb6291650a0841ece432556f784f004937f0f32c", + "sha256:ade5e387d2ad0d7ebf59146cc00c8044acbd863725f887353a10df825fc8ae21", + "sha256:b00c1de48212e4cc9603895652c5c410df699856a2853135b3967591e4beebc2", + "sha256:b1282f8c00509d99fef04d8ba936b156d419be841854fe901d8ae224c59f0be5", + "sha256:b2051432115498d3562c084a49bba65d97cf251f5a331c64a12ee7e04dacc51b", + "sha256:ba59edeaa2fc6114428f1637ffff42da1e311e29382d81b339c1817d37ec93c6", + "sha256:c8716a48d94b06bb3b2524c2b77e055fb313aeb4ea620c8dd03a105574ba704f", + "sha256:cd5df75523866410809ca100dc9681e301e3c27567cf498077e8551b6d20e42f", + "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7" + ], + "version": "==1.1.1" + }, "mccabe": { "hashes": [ "sha256:ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42", @@ -241,6 +282,13 @@ "markers": "python_version > '2.7'", "version": "==6.0.0" }, + "packaging": { + "hashes": [ + "sha256:0c98a5d0be38ed775798ece1b9727178c4469d9c3b4ada66e8e6b7849f8732af", + "sha256:9e1cbf8c12b1f1ce0bb5344b8d7ecf66a6f8a6e91bcb0c84593ed6d3ab5c4ab3" + ], + "version": "==19.0" + }, "pkginfo": { "hashes": [ "sha256:7424f2c8511c186cd5424bbf31045b77435b37a8d604990b79d4e70d741148bb", @@ -283,6 +331,13 @@ ], "version": "==2.3.1" }, + "pyparsing": { + "hashes": [ + "sha256:66c9268862641abcac4a96ba74506e594c884e3f57690a696d21ad8210ed667a", + "sha256:f6c5ef0d7480ad048c054c37632c67fca55299990fff127850181659eea33fc3" + ], + "version": "==2.3.1" + }, "pytest": { "hashes": [ "sha256:067a1d4bf827ffdd56ad21bd46674703fce77c5957f6c1eef731f6146bfcef1c", @@ -298,6 +353,13 @@ "index": "pypi", "version": "==2.6.1" }, + "pytz": { + "hashes": [ + "sha256:32b0891edff07e28efe91284ed9c31e123d84bea3fd98e1f72be2508f43ef8d9", + "sha256:d5f05e487007e29e03409f9398d074e158d920d36eb82eaf66fb1136b0c5374c" + ], + "version": "==2018.9" + }, "readme-renderer": { "hashes": [ "sha256:bb16f55b259f27f75f640acf5e00cf897845a8b3e4731b5c1a436e4b8529202f", @@ -334,6 +396,36 @@ ], "version": "==1.12.0" }, + "snowballstemmer": { + "hashes": [ + "sha256:919f26a68b2c17a7634da993d91339e288964f93c274f1343e3bbbe2096e1128", + "sha256:9f3bcd3c401c3e862ec0ebe6d2c069ebc012ce142cce209c098ccb5b09136e89" + ], + "version": "==1.2.1" + }, + "sphinx": { + "hashes": [ + "sha256:b53904fa7cb4b06a39409a492b949193a1b68cc7241a1a8ce9974f86f0d24287", + "sha256:c1c00fc4f6e8b101a0d037065043460dffc2d507257f2f11acaed71fd2b0c83c" + ], + "index": "pypi", + "version": "==1.8.4" + }, + "sphinx-rtd-theme": { + "hashes": [ + "sha256:00cf895504a7895ee433807c62094cf1e95f065843bf3acd17037c3e9a2becd4", + "sha256:728607e34d60456d736cc7991fd236afb828b21b82f956c5ea75f94c8414040a" + ], + "index": "pypi", + "version": "==0.4.3" + }, + "sphinxcontrib-websupport": { + "hashes": [ + "sha256:68ca7ff70785cbe1e7bccc71a48b5b6d965d79ca50629606c7861a21b206d9dd", + "sha256:9de47f375baf1ea07cdb3436ff39d7a9c76042c10a769c52353ec46e4e8fc3b9" + ], + "version": "==1.1.0" + }, "toml": { "hashes": [ "sha256:229f81c57791a41d65e399fc06bf0848bab550a9dfd5ed66df18ce5f05e73d5c", diff --git a/README.rst b/README.rst index d320869..323332c 100644 --- a/README.rst +++ b/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 `_ which is no longer maintained (archived). Here the original text of the pykube README: diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..298ea9e --- /dev/null +++ b/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) \ No newline at end of file diff --git a/docs/api/modules.rst b/docs/api/modules.rst new file mode 100644 index 0000000..f6aeae8 --- /dev/null +++ b/docs/api/modules.rst @@ -0,0 +1,7 @@ +pykube +====== + +.. toctree:: + :maxdepth: 4 + + pykube diff --git a/docs/api/pykube.rst b/docs/api/pykube.rst new file mode 100644 index 0000000..b1ba774 --- /dev/null +++ b/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: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..8ffd2b6 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,178 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../pykube')) + + +# -- Project information ----------------------------------------------------- + +project = 'Pykube' +copyright = '2019, Henning Jacobs' +author = 'Henning Jacobs' + +# The short X.Y version +version = '0.1' +# The full version, including alpha/beta/rc tags +release = '0.1' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# 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.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Pykubedoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Pykube.tex', 'Pykube Documentation', + 'Henning Jacobs', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'pykube', 'Pykube Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Pykube', 'Pykube Documentation', + author, 'Pykube', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..f6026c2 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,57 @@ +.. Pykube documentation master file, created by + sphinx-quickstart on Mon Mar 4 22:39:22 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Pykube +====== + +.. image:: https://img.shields.io/pypi/v/pykube-ng.svg + :target: https://pypi.python.org/pypi/pykube-ng/ + +.. image:: https://img.shields.io/pypi/pyversions/pykube-ng.svg + :target: https://pypi.python.org/pypi/pykube-ng/ + +.. image:: https://img.shields.io/badge/license-apache-blue.svg + :target: https://pypi.python.org/pypi/pykube-ng/ + +Pykube (pykube-ng) is a lightweight Python 3+ client library for Kubernetes. + +Installation +------------ + +To install pykube, use pip:: + + pip install pykube-ng + +Usage +----- + +Query for all ready pods in a custom namespace: + +.. code:: python + + import operator + import pykube + + api = pykube.HTTPClient(pykube.KubeConfig.from_file()) + pods = pykube.Pod.objects(api).filter(namespace="gondor-system") + ready_pods = filter(operator.attrgetter("ready"), pods) + +Documentation +------------- + +There is not much documentation yet, but you can check out the `README on github `_ and browse the :ref:`pykube-package`. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` From ccfaa9e599e55e8072750306f7c5e8c80f116f11 Mon Sep 17 00:00:00 2001 From: Henning Jacobs Date: Mon, 4 Mar 2019 22:59:04 +0100 Subject: [PATCH 2/4] remove some boilerplate --- docs/conf.py | 76 -------------------------------------------------- docs/index.rst | 5 ---- 2 files changed, 81 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 8ffd2b6..115ae25 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -99,80 +99,4 @@ # # html_sidebars = {} - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Pykubedoc' - - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'Pykube.tex', 'Pykube Documentation', - 'Henning Jacobs', 'manual'), -] - - -# -- Options for manual page output ------------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'pykube', 'Pykube Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ---------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'Pykube', 'Pykube Documentation', - author, 'Pykube', 'One line description of project.', - 'Miscellaneous'), -] - - -# -- Options for Epub output ------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# -# epub_identifier = '' - -# A unique identification for the text. -# -# epub_uid = '' - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - - # -- Extension configuration ------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index f6026c2..e4d5d87 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,3 @@ -.. Pykube documentation master file, created by - sphinx-quickstart on Mon Mar 4 22:39:22 2019. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Pykube ====== From 8a804bb9cc165aac88265bd20d2e7ec255d38ed3 Mon Sep 17 00:00:00 2001 From: Henning Jacobs Date: Mon, 4 Mar 2019 23:06:58 +0100 Subject: [PATCH 3/4] fix syspath and incl. README --- docs/conf.py | 2 +- docs/index.rst | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 115ae25..05543cc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,7 +14,7 @@ # import os import sys -sys.path.insert(0, os.path.abspath('../pykube')) +sys.path.insert(0, os.path.abspath('../')) # -- Project information ----------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index e4d5d87..841bfd1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -42,6 +42,8 @@ There is not much documentation yet, but you can check out the `README on github :maxdepth: 2 :caption: Contents: + readme + Indices and tables From 6e13114416ea892119901db2fca1befbe35ddccf Mon Sep 17 00:00:00 2001 From: Henning Jacobs Date: Mon, 4 Mar 2019 23:12:33 +0100 Subject: [PATCH 4/4] readthedocs requirements --- docs/requirements.txt | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..c8d5dba --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +# duplicate necessary dependencies to import pykube module (for autodoc) +requests +PyYAML