Package: python-attr-doc
Version: 16.0.0-1
Severity: minor
Tags: patch
The current build of the Sphinx documentation doesn't use the local
inventories for interwiki references.
I guess due to the suggestion from
https://wiki.debian.org/Python/LibraryStyleGuide#Sphinx_documentation
it actually doesn't refer to any inventory.
The attached patch changes the Sphinx configuration to refer to the
inventories from the python3?-doc packages locally, generating relative
links. I couldn't find a reason to not use the local interwiki inventories.
Additionally the sphinx documentation build skips most of the
documentation, as it cannot find it's own build, so I added the
following lines to conf.py:
+import sys
+sys.path.insert(0, os.path.abspath('../.pybuild/pythonX.Y_2.7/build'))
which fixes the autodoc warnings:
/«PKGBUILDDIR»/docs/api.rst:21: WARNING: autodoc: failed to import
function 's' from module 'attr'; the following exception was raised:
Traceback (most recent call last):
File "/usr/lib/python3/dist-packages/sphinx/ext/autodoc.py", line 518,
in import_object
__import__(self.modname)
ImportError: No module named 'attr'
The patch is for Ubuntu Xenial, which has an older version of
python-hypothesis and needs the additional python-enum34 package.
The dh_compress override might also be an Ubuntu debhelper bug, but
otherwise the changes.html will be compressed. I guess from the
dh_compress manpage / description that the html file and changelog case
clash here.
Otherwise it should apply cleanly to your Debian package :-)
HTH
Jan-Marek
P.S. I also didn't check the doc-base files, as I don't use them.
diff -urN debian_upstream/changelog debian_jmg/changelog
--- debian_upstream/changelog 2016-06-26 19:57:48.000000000 +0200
+++ debian_jmg/changelog 2016-08-17 01:32:35.000000000 +0200
@@ -1,3 +1,12 @@
+python-attrs (16.0.0-1~jmg1) xenial; urgency=medium
+
+ * Backport fox xenial
+ * Depend on python-enum34 for Python 2.7 unit tests
+ * Add python version specific doc package
+ - creates relative links to local python documentation
+
+ -- Jan-Marek Glogowski <glo...@fbihome.de> Tue, 16 Aug 2016 21:51:02 +0200
+
python-attrs (16.0.0-1) unstable; urgency=medium
* New upstream release.
diff -urN debian_upstream/control debian_jmg/control
--- debian_upstream/control 2016-06-26 19:57:48.000000000 +0200
+++ debian_jmg/control 2016-08-16 22:37:10.000000000 +0200
@@ -9,12 +9,15 @@
pypy,
pypy-setuptools,
python-all,
+ python-doc,
+ python-enum34,
python-hypothesis,
python-pytest,
python-setuptools,
python-sphinx-rtd-theme,
python-zope.interface,
python3-all,
+ python3-doc,
python3-hypothesis,
python3-pytest,
python3-setuptools,
@@ -47,7 +50,7 @@
Architecture: all
Depends: ${misc:Depends}, ${python3:Depends}
Recommends: ${python3:Recommends}
-Suggests: python-attr-doc, ${python3:Suggests}
+Suggests: python3-attr-doc, ${python3:Suggests}
Description: Attributes without boilerplate (Python 3)
attrs is an MIT-licensed Python package with class decorators that ease the
chores of implementing the most common attribute-related object protocols.
@@ -84,6 +87,30 @@
Architecture: all
Priority: extra
Depends: ${misc:Depends}, ${sphinxdoc:Depends}
+Suggests:
+ python-doc,
+ python-attr,
+Description: documentation for the attrs Python library
+ attrs is an MIT-licensed Python package with class decorators that ease the
+ chores of implementing the most common attribute-related object protocols.
+ .
+ You just specify the attributes to work with and attrs gives you:
+ - a nice human-readable __repr__,
+ - a complete set of comparison methods,
+ - an initializer,
+ - and much more
+ without writing dull boilerplate code again and again.
+ .
+ This package provides documentation for attrs.
+
+Package: python3-attr-doc
+Section: doc
+Architecture: all
+Priority: extra
+Depends: ${misc:Depends}, ${sphinxdoc:Depends}
+Suggests:
+ python3-doc,
+ python3-attr,
Description: documentation for the attrs Python library
attrs is an MIT-licensed Python package with class decorators that ease the
chores of implementing the most common attribute-related object protocols.
diff -urN debian_upstream/python3-attr-doc.doc-base debian_jmg/python3-attr-doc.doc-base
--- debian_upstream/python3-attr-doc.doc-base 1970-01-01 01:00:00.000000000 +0100
+++ debian_jmg/python3-attr-doc.doc-base 2016-08-17 01:44:41.000000000 +0200
@@ -0,0 +1,7 @@
+Document: python3-attr
+Title: python-attr documentation (Python 3)
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python3-attr-doc/html/index.html
+Files: /usr/share/doc/python3-attr-doc/html/*.html
diff -urN debian_upstream/python3-attr-doc.docs debian_jmg/python3-attr-doc.docs
--- debian_upstream/python3-attr-doc.docs 1970-01-01 01:00:00.000000000 +0100
+++ debian_jmg/python3-attr-doc.docs 2016-08-16 22:49:10.000000000 +0200
@@ -0,0 +1,2 @@
+.pybuild/docs3/*
+README.rst
diff -urN debian_upstream/python-attr-doc.doc-base debian_jmg/python-attr-doc.doc-base
--- debian_upstream/python-attr-doc.doc-base 2016-06-26 19:57:48.000000000 +0200
+++ debian_jmg/python-attr-doc.doc-base 2016-08-17 01:45:25.000000000 +0200
@@ -1,5 +1,5 @@
Document: python-attr
-Title: python-attr documentation
+Title: python-attr documentation (Python 2)
Section: Programming/Python
Format: HTML
diff -urN debian_upstream/python-attr-doc.docs debian_jmg/python-attr-doc.docs
--- debian_upstream/python-attr-doc.docs 2016-06-26 19:57:48.000000000 +0200
+++ debian_jmg/python-attr-doc.docs 2016-08-16 22:49:57.000000000 +0200
@@ -1,2 +1,2 @@
-.pybuild/docs/*
+.pybuild/docs2/*
README.rst
diff -urN debian_upstream/rules debian_jmg/rules
--- debian_upstream/rules 2016-06-26 19:57:48.000000000 +0200
+++ debian_jmg/rules 2016-08-17 18:52:42.000000000 +0200
@@ -6,13 +6,23 @@
%:
dh $@ --with python2,python3,pypy,sphinxdoc --buildsystem=pybuild
+override_dh_auto_clean:
+ dh_auto_clean
+ -mv docs/conf.py.bak docs/conf.py
+
override_dh_auto_build:
dh_auto_build
- PYTHONPATH=. \
- http_proxy='127.0.0.1:9' \
- https_proxy='127.0.0.1:9' \
- sphinx-build -N -b html docs/ $(CURDIR)/.pybuild/docs/html/
+ [ ! -e docs/conf.py.bak ] && cp docs/conf.py docs/conf.py.bak
+ cp debian/sphinx/conf2.py docs/conf.py
+ # The "cd" is a workaround for broken relative references when
+ # sphinx-build is run for a source directory
+ cd docs ; sphinx-build -N -b html . $(CURDIR)/.pybuild/docs2/html/
+ cp debian/sphinx/conf3.py docs/conf.py
+ cd docs ; sphinx-build -N -b html . $(CURDIR)/.pybuild/docs3/html/
override_dh_auto_test:
dh_auto_test
rm -r .pybuild/*/build/.hypothesis
+
+override_dh_compress:
+ dh_compress -Xchangelog.html
diff -urN debian_upstream/sphinx/conf2.py debian_jmg/sphinx/conf2.py
--- debian_upstream/sphinx/conf2.py 1970-01-01 01:00:00.000000000 +0100
+++ debian_jmg/sphinx/conf2.py 2016-08-17 01:06:53.000000000 +0200
@@ -0,0 +1,310 @@
+# -*- coding: utf-8 -*-
+#
+# attrs documentation build configuration file, created by
+# sphinx-quickstart on Sun May 11 16:17:15 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import codecs
+import datetime
+import os
+import re
+
+try:
+ import sphinx_rtd_theme
+except ImportError:
+ sphinx_rtd_theme = None
+
+
+def read(*parts):
+ """
+ Build an absolute path from *parts* and and return the contents of the
+ resulting file. Assume UTF-8 encoding.
+ """
+ here = os.path.abspath(os.path.dirname(__file__))
+ with codecs.open(os.path.join(here, *parts), "rb", "utf-8") as f:
+ return f.read()
+
+
+def find_version(*file_paths):
+ """
+ Build a path from *file_paths* and search for a ``__version__``
+ string inside.
+ """
+ version_file = read(*file_paths)
+ version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
+ version_file, re.M)
+ if version_match:
+ return version_match.group(1)
+ raise RuntimeError("Unable to find version string.")
+
+# 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
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+import sys
+sys.path.insert(0, os.path.abspath('../.pybuild/pythonX.Y_2.7/build'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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.doctest',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+]
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'attrs'
+year = datetime.date.today().year
+copyright = u'2015{0}, Hynek Schlawack'.format(
+ u'-{0}'.format(year) if year != 2015 else u""
+)
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+release = find_version("../src/attr/__init__.py")
+version = release.rsplit(u".", 1)[0]
+# The full version, including alpha/beta/rc tags.
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# 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
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+
+if sphinx_rtd_theme:
+ html_theme = "sphinx_rtd_theme"
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+else:
+ html_theme = "default"
+
+# 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 = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#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
+
+# 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
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# 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'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'attrsdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ ('index', 'attrs.tex', u'attrs Documentation',
+ u'Hynek Schlawack', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'attrs', u'attrs Documentation',
+ [u'Hynek Schlawack'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'attrs', u'attrs Documentation',
+ u'Hynek Schlawack', 'attrs', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+ 'python': ('../../python2.7-doc/html', '/usr/share/doc/python2.7-doc/html/objects.inv'),
+}
+
diff -urN debian_upstream/sphinx/conf3.py debian_jmg/sphinx/conf3.py
--- debian_upstream/sphinx/conf3.py 1970-01-01 01:00:00.000000000 +0100
+++ debian_jmg/sphinx/conf3.py 2016-08-17 01:07:06.000000000 +0200
@@ -0,0 +1,310 @@
+# -*- coding: utf-8 -*-
+#
+# attrs documentation build configuration file, created by
+# sphinx-quickstart on Sun May 11 16:17:15 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import codecs
+import datetime
+import os
+import re
+
+try:
+ import sphinx_rtd_theme
+except ImportError:
+ sphinx_rtd_theme = None
+
+
+def read(*parts):
+ """
+ Build an absolute path from *parts* and and return the contents of the
+ resulting file. Assume UTF-8 encoding.
+ """
+ here = os.path.abspath(os.path.dirname(__file__))
+ with codecs.open(os.path.join(here, *parts), "rb", "utf-8") as f:
+ return f.read()
+
+
+def find_version(*file_paths):
+ """
+ Build a path from *file_paths* and search for a ``__version__``
+ string inside.
+ """
+ version_file = read(*file_paths)
+ version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
+ version_file, re.M)
+ if version_match:
+ return version_match.group(1)
+ raise RuntimeError("Unable to find version string.")
+
+# 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
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+import sys
+sys.path.insert(0, os.path.abspath('../.pybuild/pythonX.Y_3.5/build'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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.doctest',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.todo',
+]
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'attrs'
+year = datetime.date.today().year
+copyright = u'2015{0}, Hynek Schlawack'.format(
+ u'-{0}'.format(year) if year != 2015 else u""
+)
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+release = find_version("../src/attr/__init__.py")
+version = release.rsplit(u".", 1)[0]
+# The full version, including alpha/beta/rc tags.
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# 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
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+
+if sphinx_rtd_theme:
+ html_theme = "sphinx_rtd_theme"
+ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+else:
+ html_theme = "default"
+
+# 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 = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#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
+
+# 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
+
+# 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,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# 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'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'attrsdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+ # The paper size ('letterpaper' or 'a4paper').
+ #'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #'pointsize': '10pt',
+
+ # Additional stuff for the LaTeX preamble.
+ #'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ ('index', 'attrs.tex', u'attrs Documentation',
+ u'Hynek Schlawack', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'attrs', u'attrs Documentation',
+ [u'Hynek Schlawack'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'attrs', u'attrs Documentation',
+ u'Hynek Schlawack', 'attrs', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+ 'python': ('../../python3-doc/html', '/usr/share/doc/python3-doc/html/objects.inv')
+}
+
