Directory Structure
Entrypoints
API
CLI
UI
Schemas
Build
Test
Security
Bookmarks

.github
- ISSUE_TEMPLATE
- workflows
- PULL_REQUEST_TEMPLATE.md
- dependabot.yml
devel
- release.md
- stats.md
doc
- source
- .gitignore
- Makefile
- README.md
- requirements-docs.txt
examples
- dynamic-client
- notebooks
- watch
- yaml_dir
- README.md
- __init__.py
- annotate_deployment.py
- api_discovery.py
- apply_from_dict.py
- apply_from_directory.py
- apply_from_single_file.py
- cluster_scoped_custom_object.py
- cronjob_crud.py
- deployment_create.py
- deployment_crud.py
- duration-gep2257.py
- in_cluster_config.py
- ingress_create.py
- job_crud.py
- multiple_clusters.py
- namespaced_custom_object.py
- node_labels.py
- out_of_cluster_config.py
- pick_kube_config_context.py
- pod_config_list.py
- pod_exec.py
- pod_portforward.py
- remote_cluster.py
- rollout-daemonset.py
- rollout-statefulset.py
kubernetes
- .openapi-generator
- base
- client
- config
- docs
- dynamic
- e2e_test
- leaderelection
- stream
- test
- utils
- watch
- .gitlab-ci.yml
- .openapi-generator-ignore
- README.md
- __init__.py
- setup.cfg
- swagger.json.unprocessed
scripts
- util
- .gitignore
- apply-hotfixes.sh
- cherry_pick_pull.sh
- constants.py
- kube-init.sh
- release.sh
- rest_client_patch.diff
- rest_sni_patch.diff
- rest_urllib_headers.diff
- swagger.json
- update-client.sh
- update-pycodestyle.sh
- windows-setup-fix.bat
.gitignore
CHANGELOG.md
CONTRIBUTING.md
LICENSE
MANIFEST.in
OWNERS
README.md
SECURITY_CONTACTS
code-of-conduct.md
codecov.yml
requirements.txt
setup.cfg
setup.py
test-requirements.txt
tox.ini

Your advanced code editor is loading.

Please wait a moment.

#editor-loading { display: none; }

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 re import sys

from recommonmark.transform import AutoStructify

–

Copy README.md, CONTRIBUTING.md to source/ directory and replace

all paths to point github files.

def _copy_with_converting_link_to_repo(filename, new_filename): base_url = ‘’

def subf(subs):
          label, url = subs.groups()
          if not url.startswith('http://') and not url.startswith('https://'):
          url = base_url + url
          return label + '(' + url + ')'
          
          with open(filename, "r") as r:
          data = re.sub("([[^]]+])(([^)]+))", subf, r.read())
          with open(new_filename, "w") as w:
          w.write(data)

_copy_with_converting_link_to_repo(“../../README.md”, “README.md”) _copy_with_converting_link_to_repo(“../../CONTRIBUTING.md”, “CONTRIBUTING.md”)

–

sys.path.insert(0, os.path.abspath(‘../..’))

– General configuration —————————————————-

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_markdown_tables’, ‘recommonmark’, ‘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} def setup(app): app.add_config_value(‘recommonmark_config’, { ‘auto_toc_tree_section’: ‘Contents’, ‘enable_eval_rst’: True, }, True) app.add_transform(AutoStructify)

Explanation

This code configures Sphinx, a documentation generator, for the kubernetes-client/python project.

Key Points:

README and CONTRIBUTING files: The code copies README.md and CONTRIBUTING.md into the source/ directory, converting any relative links in these files to point to their corresponding GitHub locations.
Sphinx Extensions: The extensions list enables features like markdown table support (sphinx_markdown_tables) and the use of Markdown as a source format (recommonmark). Autodoc is enabled to automatically generate documentation from docstrings.
Autodoc: The autodoc extension is configured to automatically generate documentation from docstrings. The export SPHINX_DEBUG=1 environment variable can be set to disable this behavior if needed.
Master Document: The master_doc variable specifies the main document used to generate the documentation.
Project Information: The project variable sets the project name, which is used in various output formats.
HTML Output: The code sets basic configurations for the HTML output, but it doesn’t use any custom theme, leaving the default theme.
LaTeX Output: Configuration for generating LaTeX documentation is provided.
InterSphinx: Comments are present for configuring intersphinx, which is a mechanism to link to external documentation, but it’s not currently used.
Recommonmark Setup: The setup function configures recommonmark to automatically generate a table of contents and enable the evaluation of reStructuredText within Markdown files.

Overall: This configuration file defines the basic settings for generating documentation with Sphinx for the kubernetes-client/python project. It enables the use of Markdown, automatically generates documentation from docstrings, and provides configurations for various output formats.

Your advanced code editor is loading.

Please wait a moment.

Explanation

Graph

Symbols

We couldn't identify any entrypoints. If you believe this to be incorrect then please contact support.