|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +# |
| 3 | +# ssh2-python documentation build configuration file, created by |
| 4 | +# sphinx-quickstart on Mon Aug 7 11:22:12 2017. |
| 5 | +# |
| 6 | +# This file is execfile()d with the current directory set to its |
| 7 | +# containing dir. |
| 8 | +# |
| 9 | +# Note that not all possible configuration values are present in this |
| 10 | +# autogenerated file. |
| 11 | +# |
| 12 | +# All configuration values have a default; values that are commented out |
| 13 | +# serve to show the default. |
| 14 | + |
| 15 | +# If extensions (or modules to document with autodoc) are in another directory, |
| 16 | +# add these directories to sys.path here. If the directory is relative to the |
| 17 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 18 | +# |
| 19 | +import os |
| 20 | +import sys |
| 21 | +sys.path.insert(0, os.path.abspath('..')) |
| 22 | +import ssh2 |
| 23 | + |
| 24 | + |
| 25 | +# -- General configuration ------------------------------------------------ |
| 26 | + |
| 27 | +# If your documentation needs a minimal Sphinx version, state it here. |
| 28 | +# |
| 29 | +# needs_sphinx = '1.0' |
| 30 | + |
| 31 | +# Add any Sphinx extension module names here, as strings. They can be |
| 32 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 33 | +# ones. |
| 34 | +extensions = ['sphinx.ext.autodoc', |
| 35 | + 'sphinx.ext.intersphinx', |
| 36 | + 'sphinx.ext.todo', |
| 37 | +] |
| 38 | + |
| 39 | +autodoc_default_flags = ['members'] |
| 40 | + |
| 41 | +# Add any paths that contain templates here, relative to this directory. |
| 42 | +templates_path = ['_templates'] |
| 43 | + |
| 44 | +# The suffix(es) of source filenames. |
| 45 | +# You can specify multiple suffix as a list of string: |
| 46 | +# |
| 47 | +# source_suffix = ['.rst', '.md'] |
| 48 | +source_suffix = '.rst' |
| 49 | + |
| 50 | +# The master toctree document. |
| 51 | +master_doc = 'index' |
| 52 | + |
| 53 | +# General information about the project. |
| 54 | +project = u'ssh2-python' |
| 55 | +copyright = u'2017, P Kittenis' |
| 56 | +author = u'P Kittenis' |
| 57 | + |
| 58 | +# The version info for the project you're documenting, acts as replacement for |
| 59 | +# |version| and |release|, also used in various other places throughout the |
| 60 | +# built documents. |
| 61 | +# |
| 62 | +# The short X.Y version. |
| 63 | +version = ssh2.__version__ |
| 64 | +# The full version, including alpha/beta/rc tags. |
| 65 | +release = ssh2.__version__ |
| 66 | + |
| 67 | +# The language for content autogenerated by Sphinx. Refer to documentation |
| 68 | +# for a list of supported languages. |
| 69 | +# |
| 70 | +# This is also used if you do content translation via gettext catalogs. |
| 71 | +# Usually you set "language" from the command line for these cases. |
| 72 | +language = None |
| 73 | + |
| 74 | +# List of patterns, relative to source directory, that match files and |
| 75 | +# directories to ignore when looking for source files. |
| 76 | +# This patterns also effect to html_static_path and html_extra_path |
| 77 | +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 78 | + |
| 79 | +# The name of the Pygments (syntax highlighting) style to use. |
| 80 | +pygments_style = 'sphinx' |
| 81 | + |
| 82 | +# If true, `todo` and `todoList` produce output, else they produce nothing. |
| 83 | +todo_include_todos = True |
| 84 | + |
| 85 | + |
| 86 | +# -- Options for HTML output ---------------------------------------------- |
| 87 | + |
| 88 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
| 89 | +# a list of builtin themes. |
| 90 | +# |
| 91 | +html_theme = 'sphinx_rtd_theme' |
| 92 | + |
| 93 | +# Theme options are theme-specific and customize the look and feel of a theme |
| 94 | +# further. For a list of options available for each theme, see the |
| 95 | +# documentation. |
| 96 | +# |
| 97 | +# html_theme_options = {} |
| 98 | + |
| 99 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 100 | +# relative to this directory. They are copied after the builtin static files, |
| 101 | +# so a file named "default.css" will overwrite the builtin "default.css". |
| 102 | +html_static_path = ['_static'] |
| 103 | + |
| 104 | +# Custom sidebar templates, must be a dictionary that maps document names |
| 105 | +# to template names. |
| 106 | +# |
| 107 | +# This is required for the alabaster theme |
| 108 | +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars |
| 109 | +html_sidebars = { |
| 110 | + '**': [ |
| 111 | + 'about.html', |
| 112 | + 'navigation.html', |
| 113 | + 'relations.html', # needs 'show_related': True theme option to display |
| 114 | + 'searchbox.html', |
| 115 | + 'donate.html', |
| 116 | + ] |
| 117 | +} |
| 118 | + |
| 119 | + |
| 120 | +# -- Options for HTMLHelp output ------------------------------------------ |
| 121 | + |
| 122 | +# Output file base name for HTML help builder. |
| 123 | +htmlhelp_basename = 'ssh2-pythondoc' |
| 124 | + |
| 125 | + |
| 126 | +# -- Options for LaTeX output --------------------------------------------- |
| 127 | + |
| 128 | +latex_elements = { |
| 129 | + # The paper size ('letterpaper' or 'a4paper'). |
| 130 | + # |
| 131 | + # 'papersize': 'letterpaper', |
| 132 | + |
| 133 | + # The font size ('10pt', '11pt' or '12pt'). |
| 134 | + # |
| 135 | + # 'pointsize': '10pt', |
| 136 | + |
| 137 | + # Additional stuff for the LaTeX preamble. |
| 138 | + # |
| 139 | + # 'preamble': '', |
| 140 | + |
| 141 | + # Latex figure (float) alignment |
| 142 | + # |
| 143 | + # 'figure_align': 'htbp', |
| 144 | +} |
| 145 | + |
| 146 | +# Grouping the document tree into LaTeX files. List of tuples |
| 147 | +# (source start file, target name, title, |
| 148 | +# author, documentclass [howto, manual, or own class]). |
| 149 | +latex_documents = [ |
| 150 | + (master_doc, 'ssh2-python.tex', u'ssh2-python Documentation', |
| 151 | + u'P Kittenis', 'manual'), |
| 152 | +] |
| 153 | + |
| 154 | + |
| 155 | +# -- Options for manual page output --------------------------------------- |
| 156 | + |
| 157 | +# One entry per manual page. List of tuples |
| 158 | +# (source start file, name, description, authors, manual section). |
| 159 | +man_pages = [ |
| 160 | + (master_doc, 'ssh2-python', u'ssh2-python Documentation', |
| 161 | + [author], 1) |
| 162 | +] |
| 163 | + |
| 164 | + |
| 165 | +# -- Options for Texinfo output ------------------------------------------- |
| 166 | + |
| 167 | +# Grouping the document tree into Texinfo files. List of tuples |
| 168 | +# (source start file, target name, title, author, |
| 169 | +# dir menu entry, description, category) |
| 170 | +texinfo_documents = [ |
| 171 | + (master_doc, 'ssh2-python', u'ssh2-python Documentation', |
| 172 | + author, 'ssh2-python', 'Python SSH library based on libssh2.', |
| 173 | + 'Miscellaneous'), |
| 174 | +] |
| 175 | + |
| 176 | + |
| 177 | + |
| 178 | + |
| 179 | +# Example configuration for intersphinx: refer to the Python standard library. |
| 180 | +intersphinx_mapping = {'https://docs.python.org/': None} |
| 181 | +autoclass_content = "both" |
0 commit comments