|
Packit Service |
30b792 |
# -*- coding: utf-8 -*-
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# Configuration file for the Sphinx documentation builder.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# This file does only contain a selection of the most common options. For a
|
|
Packit Service |
30b792 |
# full list see the documentation:
|
|
Packit Service |
30b792 |
# http://www.sphinx-doc.org/en/master/config
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# -- Path setup --------------------------------------------------------------
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# If extensions (or modules to document with autodoc) are in another directory,
|
|
Packit Service |
30b792 |
# add these directories to sys.path here. If the directory is relative to the
|
|
Packit Service |
30b792 |
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# import os
|
|
Packit Service |
30b792 |
# import sys
|
|
Packit Service |
30b792 |
# sys.path.insert(0, os.path.abspath('.'))
|
|
Packit Service |
30b792 |
import hashlib
|
|
Packit Service |
30b792 |
import time
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# -- Project information -----------------------------------------------------
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
project = 'GPGME Python Bindings'
|
|
Packit Service |
30b792 |
copyright = '2018, The GnuPG Hackers'
|
|
Packit Service |
30b792 |
author = 'The GnuPG Hackers'
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# The short X.Y version
|
|
Packit Service |
30b792 |
version = ''
|
|
Packit Service |
30b792 |
# The full version, including alpha/beta/rc tags
|
|
Packit Service |
30b792 |
release = ''
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# -- General configuration ---------------------------------------------------
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# If your documentation needs a minimal Sphinx version, state it here.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# needs_sphinx = '1.0'
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Add any Sphinx extension module names here, as strings. They can be
|
|
Packit Service |
30b792 |
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
Packit Service |
30b792 |
# ones.
|
|
Packit Service |
30b792 |
extensions = [
|
|
Packit Service |
30b792 |
]
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Add any paths that contain templates here, relative to this directory.
|
|
Packit Service |
30b792 |
templates_path = ['_templates']
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# The suffix(es) of source filenames.
|
|
Packit Service |
30b792 |
# You can specify multiple suffix as a list of string:
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# source_suffix = ['.rst', '.md']
|
|
Packit Service |
30b792 |
source_suffix = '.rst'
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# The master toctree document.
|
|
Packit Service |
30b792 |
master_doc = 'index'
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
Packit Service |
30b792 |
# for a list of supported languages.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# This is also used if you do content translation via gettext catalogs.
|
|
Packit Service |
30b792 |
# Usually you set "language" from the command line for these cases.
|
|
Packit Service |
30b792 |
language = None
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# List of patterns, relative to source directory, that match files and
|
|
Packit Service |
30b792 |
# directories to ignore when looking for source files.
|
|
Packit Service |
30b792 |
# This pattern also affects html_static_path and html_extra_path.
|
|
Packit Service |
30b792 |
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# The name of the Pygments (syntax highlighting) style to use.
|
|
Packit Service |
30b792 |
pygments_style = None
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# -- Options for HTML output -------------------------------------------------
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
Packit Service |
30b792 |
# a list of builtin themes.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
html_theme = 'alabaster'
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Theme options are theme-specific and customize the look and feel of a theme
|
|
Packit Service |
30b792 |
# further. For a list of options available for each theme, see the
|
|
Packit Service |
30b792 |
# documentation.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# html_theme_options = {}
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Add any paths that contain custom static files (such as style sheets) here,
|
|
Packit Service |
30b792 |
# relative to this directory. They are copied after the builtin static files,
|
|
Packit Service |
30b792 |
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
Packit Service |
30b792 |
html_static_path = ['_static']
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Custom sidebar templates, must be a dictionary that maps document names
|
|
Packit Service |
30b792 |
# to template names.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# The default sidebars (for documents that don't match any pattern) are
|
|
Packit Service |
30b792 |
# defined by theme itself. Builtin themes are using these templates by
|
|
Packit Service |
30b792 |
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
|
Packit Service |
30b792 |
# 'searchbox.html']``.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# html_sidebars = {}
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# -- Options for HTMLHelp output ---------------------------------------------
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Output file base name for HTML help builder.
|
|
Packit Service |
30b792 |
htmlhelp_basename = 'GPGMEPythonBindings'
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# -- Options for LaTeX output ------------------------------------------------
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
latex_elements = {
|
|
Packit Service |
30b792 |
# The paper size ('letterpaper' or 'a4paper').
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# 'papersize': 'letterpaper',
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# The font size ('10pt', '11pt' or '12pt').
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# 'pointsize': '10pt',
|
|
Packit Service |
30b792 |
'pointsize': '12pt'
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Additional stuff for the LaTeX preamble.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# 'preamble': '',
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Latex figure (float) alignment
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# 'figure_align': 'htbp',
|
|
Packit Service |
30b792 |
}
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Grouping the document tree into LaTeX files. List of tuples
|
|
Packit Service |
30b792 |
# (source start file, target name, title,
|
|
Packit Service |
30b792 |
# author, documentclass [howto, manual, or own class]).
|
|
Packit Service |
30b792 |
latex_documents = [
|
|
Packit Service |
30b792 |
(master_doc, 'GPGMEPythonBindings.tex',
|
|
Packit Service |
30b792 |
'GPGME Python Bindings Documentation',
|
|
Packit Service |
30b792 |
'The GnuPG Hackers', 'manual'),
|
|
Packit Service |
30b792 |
]
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# -- Options for manual page output ------------------------------------------
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# One entry per manual page. List of tuples
|
|
Packit Service |
30b792 |
# (source start file, name, description, authors, manual section).
|
|
Packit Service |
30b792 |
man_pages = [
|
|
Packit Service |
30b792 |
(master_doc, 'gpgmepythonbindings', 'GPGME Python Bindings Documentation',
|
|
Packit Service |
30b792 |
[author], 1)
|
|
Packit Service |
30b792 |
]
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# -- Options for Texinfo output ----------------------------------------------
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Grouping the document tree into Texinfo files. List of tuples
|
|
Packit Service |
30b792 |
# (source start file, target name, title, author,
|
|
Packit Service |
30b792 |
# dir menu entry, description, category)
|
|
Packit Service |
30b792 |
texinfo_documents = [
|
|
Packit Service |
30b792 |
(master_doc, 'GPGMEPythonBindings', 'GPGME Python Bindings Documentation',
|
|
Packit Service |
30b792 |
author, 'GPGMEPythonBindings',
|
|
Packit Service |
30b792 |
'Python Bindings to the GNU Privacy Guard API.', 'Miscellaneous'),
|
|
Packit Service |
30b792 |
]
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# -- Options for Epub output -------------------------------------------------
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# Bibliographic Dublin Core info.
|
|
Packit Service |
30b792 |
epub_title = project
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# The unique identifier of the text. This can be an ISBN number
|
|
Packit Service |
30b792 |
# or the project homepage.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# epub_identifier = ''
|
|
Packit Service |
30b792 |
epub_identifier = 'org.gnupg.gpgme.python'
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# A unique identification for the text.
|
|
Packit Service |
30b792 |
#
|
|
Packit Service |
30b792 |
# epub_uid = ''
|
|
Packit Service |
30b792 |
stt = str(time.time())
|
|
Packit Service |
30b792 |
epub_seed = "{0} {1}".format(epub_identifier, tt)
|
|
Packit Service |
30b792 |
# SHA1 would be more than fine for this, but since the dimmest always panic
|
|
Packit Service |
30b792 |
# about any use of SHA1 with GnuPG, we'll use SHA256.
|
|
Packit Service |
30b792 |
epub_hash = hashlib.sha256(epub_seed).hexdigest()
|
|
Packit Service |
30b792 |
epub_uid = 'sha256:{0}'.format(epub_hash)
|
|
Packit Service |
30b792 |
|
|
Packit Service |
30b792 |
# A list of files that should not be packed into the epub file.
|
|
Packit Service |
30b792 |
epub_exclude_files = ['search.html']
|