diff --git a/doc/src/conf.py b/doc/src/conf.py index f81c4841..8511e591 100644 --- a/doc/src/conf.py +++ b/doc/src/conf.py @@ -11,7 +11,8 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +import os +import sys # 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 @@ -22,11 +23,16 @@ sys.path.append(os.path.abspath('tools/lib')) # 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.todo', 'sphinx.ext.ifconfig', - 'sphinx.ext.doctest', 'sphinx.ext.intersphinx' ] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.ifconfig', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', +] # Specific extensions for Psycopg documentation. -extensions += [ 'dbapi_extension', 'sql_role', 'ticket_role' ] +extensions += ['dbapi_extension', 'sql_role', 'ticket_role'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -35,14 +41,16 @@ templates_path = ['_templates'] source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8' +# source_encoding = 'utf-8' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Psycopg' -copyright = u'2001-2020, Federico Di Gregorio, Daniele Varrazzo, The Psycopg Team' +copyright = ( + u'2001-2020, Federico Di Gregorio, Daniele Varrazzo, The Psycopg Team' +) # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -54,15 +62,14 @@ version = '2.0' # The full version, including alpha/beta/rc tags. try: import psycopg2 - release = psycopg2.__version__.split()[0] - version = '.'.join(release.split('.')[:2]) except ImportError: print("WARNING: couldn't import psycopg to read version.") release = version +else: + release = psycopg2.__version__.split()[0] + version = '.'.join(release.split('.')[:2]) -intersphinx_mapping = { - 'py': ('https://docs.python.org/3', None), -} +intersphinx_mapping = {'py': ('https://docs.python.org/3', None)} # Pattern to generate links to the bug tracker ticket_url = 'https://github.com/psycopg/psycopg2/issues/%s' @@ -71,16 +78,16 @@ ticket_remap_offset = 230 # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of documents that shouldn't be included in the build. -#unused_docs = [] +# unused_docs = [] # List of directories, relative to source directory, that shouldn't be searched # for source files. @@ -90,15 +97,15 @@ exclude_trees = ['_build', 'html'] default_role = 'obj' # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# 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 +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # Using 'python' instead of the default gives warnings if parsing an example # fails, instead of defaulting to none @@ -108,7 +115,7 @@ highlight_language = 'python' pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # Include TODO items in the documentation todo_include_todos = False @@ -136,29 +143,32 @@ html_theme = 'classic' # adding a few classes. html_style = 'psycopg.css' +# Hide the sphinx footer +html_show_sphinx = False + # 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 = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # 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, @@ -167,38 +177,38 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_use_modindex = True +# html_use_modindex = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' +# html_file_suffix = '' # Output file base name for HTML help builder. htmlhelp_basename = 'psycopgdoc' @@ -207,34 +217,39 @@ htmlhelp_basename = 'psycopgdoc' # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +# latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +# latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'psycopg.tex', u'Psycopg Documentation', - u'Federico Di Gregorio', 'manual'), + ( + 'index', + 'psycopg.tex', + u'Psycopg Documentation', + u'Federico Di Gregorio', + 'manual', + ) ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # Additional stuff for the LaTeX preamble. -#latex_preamble = '' +# latex_preamble = '' # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_use_modindex = True +# latex_use_modindex = True doctest_global_setup = """