|
| 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'openshift-restclient-python' |
| 48 | +copyright = u'2017, Red Hat, Inc.' |
| 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'OpenShift', 'manual'), |
| 79 | +] |
| 80 | + |
| 81 | +# Example configuration for intersphinx: refer to the Python standard library. |
| 82 | +# intersphinx_mapping = {'http://docs.python.org/': None} |
0 commit comments