Commit dd6260e9 authored by Nsukami Patrick's avatar Nsukami Patrick

[formatting] Fix various flake8 errors

- use autopep8 & black
- declare names in the public API using __all__ attribute
- fix a typo: AccDocXMLWriterTest instead of AccDocXMLWriterGenericTest
parent 286b9baec64
Pipeline #9100 passed with stage
in 2 minutes and 57 seconds
......@@ -9,12 +9,13 @@
# All configuration values have a default value; values that are commented out
# serve to show the default value.
import sys, os
import sys
import os
# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
#sys.path.append(os.path.abspath('some/directory'))
# sys.path.append(os.path.abspath('some/directory'))
# General configuration
# ---------------------
......@@ -22,61 +23,61 @@ import sys, os
# 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"]
autoclass_content = 'class'
autoclass_content = "class"
# Add any paths that contain templates here, relative to this directory.
templates_path = []
# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General substitutions.
project = 'PyBill'
copyright = '2001-2020, Logilab'
project = "PyBill"
copyright = "2001-2020, Logilab"
language = "en"
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
#
# The short X.Y version.
version = '1.0'
version = "1.0"
# The full version, including alpha/beta/rc tags.
release = '1.0.1'
release = "1.0.1"
# A list of ignored prefixes names for module index sorting.
modindex_common_prefix = ["pybill."]
# 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 directories, that shouldn't be
# searched for source files.
exclude_trees = ["_build", "_static", "_themes", "_resources", "_templates"]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# default_role = None
# 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
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# Options for HTML output
......@@ -88,23 +89,23 @@ html_theme_path = ["../_themes"]
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
#html_style = 'default.css'
# html_style = 'default.css'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'PyBill Developer Manual'
html_title = "PyBill Developer Manual"
# 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 (within the static path) 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,
......@@ -113,18 +114,18 @@ html_static_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'
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
......@@ -133,7 +134,7 @@ html_use_modindex = 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, the reST sources are included in the HTML build as _sources/<name>.
html_copy_source = False
......@@ -141,29 +142,30 @@ html_copy_source = False
# 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 = ''
# html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
html_file_suffix = '.html'
html_file_suffix = ".html"
# Output file base name for HTML help builder.
htmlhelp_basename = 'pybill_dev_help'
htmlhelp_basename = "pybill_dev_help"
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
latex_paper_size = 'a4'
latex_paper_size = "a4"
# 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, document class [howto/manual]).
latex_documents = [('index', 'pybill_dev_manual.tex',
'PyBill Developer Manual', 'Logilab', 'manual'), ]
latex_documents = [
("index", "pybill_dev_manual.tex", "PyBill Developer Manual", "Logilab", "manual"),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
......@@ -171,13 +173,13 @@ latex_logo = "../_themes/lglb_doc/logilab_logo.pdf"
# 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
......@@ -9,12 +9,13 @@
# All configuration values have a default value; values that are commented out
# serve to show the default value.
import sys, os
import sys
import os
# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
#sys.path.append(os.path.abspath('some/directory'))
# sys.path.append(os.path.abspath('some/directory'))
# General configuration
# ---------------------
......@@ -26,56 +27,56 @@ extensions = []
templates_path = []
# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General substitutions.
project = 'PyBill'
copyright = '2001-2010, Logilab'
project = "PyBill"
copyright = "2001-2010, Logilab"
language = "en"
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
#
# The short X.Y version.
version = '1.0'
version = "1.0"
# The full version, including alpha/beta/rc tags.
release = '1.0.1'
release = "1.0.1"
# A list of ignored prefixes names for module index sorting.
modindex_common_prefix = []
# 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 directories, that shouldn't be
# searched for source files.
exclude_trees = ["_build", "_static", "_themes", "_resources", "_templates"]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# default_role = None
# 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
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# Options for HTML output
......@@ -87,23 +88,23 @@ html_theme_path = ["../_themes"]
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
#html_style = 'default.css'
# html_style = 'default.css'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'PyBill Installation Manual'
html_title = "PyBill Installation Manual"
# 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 (within the static path) 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,
......@@ -112,18 +113,18 @@ html_static_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'
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 = False
......@@ -132,7 +133,7 @@ html_use_modindex = False
html_use_index = False
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False
# If true, the reST sources are included in the HTML build as _sources/<name>.
html_copy_source = False
......@@ -140,29 +141,36 @@ html_copy_source = False
# 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 = ''
# html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
html_file_suffix = '.html'
html_file_suffix = ".html"
# Output file base name for HTML help builder.
htmlhelp_basename = 'pybill_install_help'
htmlhelp_basename = "pybill_install_help"
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
latex_paper_size = 'a4'
latex_paper_size = "a4"
# 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, document class [howto/manual]).
latex_documents = [('index', 'pybill_install_manual.tex',
'PyBill Installation Manual', 'Logilab', 'manual'), ]
latex_documents = [
(
"index",
"pybill_install_manual.tex",
"PyBill Installation Manual",
"Logilab",
"manual",
),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
......@@ -170,13 +178,13 @@ latex_logo = "../_themes/lglb_doc/logilab_logo.pdf"
# 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 = False
......@@ -9,12 +9,13 @@
# All configuration values have a default value; values that are commented out
# serve to show the default value.
import sys, os
import sys
import os
# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
#sys.path.append(os.path.abspath('some/directory'))
# sys.path.append(os.path.abspath('some/directory'))
# General configuration
# ---------------------
......@@ -26,56 +27,56 @@ extensions = []
templates_path = []
# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General substitutions.
project = 'PyBill'
copyright = '2001-2010, Logilab'
project = "PyBill"
copyright = "2001-2010, Logilab"
language = "en"
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
#
# The short X.Y version.
version = '1.0'
version = "1.0"
# The full version, including alpha/beta/rc tags.
release = '1.0.1'
release = "1.0.1"
# A list of ignored prefixes names for module index sorting.
modindex_common_prefix = []
# 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 directories, that shouldn't be
# searched for source files.
exclude_trees = ["_build", "_static", "_themes", "_resources", "_templates"]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# default_role = None
# 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
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# Options for HTML output
......@@ -87,23 +88,23 @@ html_theme_path = ["../_themes"]
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
#html_style = 'default.css'
# html_style = 'default.css'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'PyBill User Manual'
html_title = "PyBill User Manual"
# 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 (within the static path) 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,
......@@ -112,18 +113,18 @@ html_static_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'
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 = False
......@@ -132,7 +133,7 @@ html_use_modindex = False
html_use_index = False
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False
# If true, the reST sources are included in the HTML build as _sources/<name>.
html_copy_source = False
......@@ -140,29 +141,30 @@ html_copy_source = False
# 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 = ''
# html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
html_file_suffix = '.html'
html_file_suffix = ".html"
# Output file base name for HTML help builder.
htmlhelp_basename = 'pybill_user_help'
htmlhelp_basename = "pybill_user_help"
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
latex_paper_size = 'a4'
latex_paper_size = "a4"
# 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, document class [howto/manual]).
latex_documents = [('index', 'pybill_user_manual.tex',
'PyBill User Manual', 'Logilab', 'manual'), ]
latex_documents = [
("index", "pybill_user_manual.tex", "PyBill User Manual", "Logilab", "manual"),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
......@@ -170,13 +172,13 @@ latex_logo = "../_themes/lglb_doc/logilab_logo.pdf"
# 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 = False
......@@ -20,15 +20,15 @@ __docformat__ = "restructuredtext en"
from os.path import join
distname = 'pybill'
modname = 'pybill'
debian_name = 'pybill'
distname = "pybill"
modname = "pybill"
debian_name = "pybill"
numversion = (1, 1, 0)
version = '.'.join([str(num) for num in numversion])
pyversions = ['3.6']
version = ".".join([str(num) for num in numversion])
pyversions = ["3.6"]
license = 'LGPL'
license = "LGPL"
description = "PDF formatting tool for bills"
mailinglist = "mailto://python-projects@lists.logilab.org"
web = "http://www.logilab.org/project/%s" % distname
......@@ -37,18 +37,19 @@ author_email = "olivier.cayrol@logilab.fr"
# executable (include the 'bin' directory in the name)