diff --git a/doc/conf.py.in b/doc/conf.py.in index e223b7ef8cb68b2d77e6f0748735e9a697855796..a0707ded34de5805af1122a80192d31314b1c75d 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -14,7 +14,9 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +# pylint: disable=invalid-name,missing-docstring + +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 @@ -50,7 +52,7 @@ master_doc = 'index' # General information about the project. project = u'ProMod3' -copyright = u'2014, Bienchen' +copyright = u'2014, Bienchen'# pylint: disable=redefined-builtin # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -179,21 +181,21 @@ htmlhelp_basename = 'ProMod3doc' # -- Options for LaTeX output -------------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # 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]). latex_documents = [ - ('index', 'ProMod3.tex', u'ProMod3 Documentation', - u'Bienchen', 'manual'), + ('index', 'ProMod3.tex', u'ProMod3 Documentation', + u'Bienchen', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -236,9 +238,9 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'ProMod3', u'ProMod3 Documentation', - u'Bienchen', 'ProMod3', 'One line description of project.', - 'Miscellaneous'), + ('index', 'ProMod3', u'ProMod3 Documentation', + u'Bienchen', 'ProMod3', 'One line description of project.', + 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. @@ -294,10 +296,11 @@ class DocTestLogger(ost.LogSink): ost.LogSink.__init__(self) def LogMessage(self, message, severity): - levels = ['ERROR', 'WARNING', 'SCRIPT', 'INFO', 'VERBOSE', 'DEBUG', - 'TRACE'] - level = levels[severity] - print '%s' % (message), + # there is a reason why we do not put 'severity' to any use in the message + # written to stdou. If we modify the message handed in by a doctest, + # verifying it would mean the creator of the doctest would have to check + # that very code here to get the test right. + sys.stdout.write('%s' % message) doctest_logger = DocTestLogger() ost.PushLogSink(doctest_logger) diff --git a/extras/pre_commit/pre-commit b/extras/pre_commit/pre-commit index f20af9065eeb750cf9d6383087374b7938875c4a..a8332d5bc130a3021ce2016747dbd19f7fd8b0b7 100644 --- a/extras/pre_commit/pre-commit +++ b/extras/pre_commit/pre-commit @@ -20,7 +20,7 @@ WHITESPACECHECK_EXCLUDES = [r'.*\.pdf', r'.*\.pdb'] ## files like documentation as HTML files. EXCLUDE_COMPLETELY = [r'^doc/html/.*\.html', r'^doc/html/.*\.js', r'^doc/html/.*\.inv', r'^doc/html/.*\.txt'] -PYCODECHECK_EXCLUDES = ['extras/pre_commit/pre-commit','doc/cmake.py','doc/conf.py.in'] +PYCODECHECK_EXCLUDES = ['extras/pre_commit/pre-commit','doc/cmake.py'] ALLOW_LONG_LINES = ['extras/pre_commit/pm3_csc/filecheck/pylint-unittest-rc', 'extras/pre_commit/pm3_csc/filecheck/pylintrc']