Fix documentation build
[third_party/pep8] / docs / api.rst
index 09bedb95d561de2c09bfe23f5c973f53c9b1563a..b346abab01a7c0bdead03cba57e378b43ac19010 100644 (file)
@@ -18,29 +18,29 @@ Checker Classes
 The :class:`StyleGuide` class is used to configure a style guide checker
 instance to check multiple files.
 
-The :class:`Checker` class can be used to check is a single file.
+The :class:`Checker` class can be used to check a single file.
 
 
-.. autoclass:: StyleGuide(*args, **kwargs)
+.. autoclass:: StyleGuide(parse_argv=False, config_file=None, parser=None, paths=None, report=None, **kwargs)
 
    .. automethod:: init_report(reporter=None)
    .. automethod:: check_files(paths=None)
    .. automethod:: input_file(filename, lines=None, expected=None, line_offset=0)
    .. automethod:: input_dir(dirname)
-   .. automethod:: excluded(filename)
+   .. automethod:: excluded(filename, parent=None)
    .. automethod:: ignore_code(code)
    .. automethod:: get_checks(argument_name)
 
-.. autoclass:: Checker(filename=None, lines=None, options=None, report=None, **kwargs)
+.. autoclass:: Checker(filename=None, lines=None, report=None, **kwargs)
 
    .. automethod:: readline
-   .. automethod:: readline_check_physical
    .. automethod:: run_check(check, argument_names)
    .. automethod:: check_physical(line)
    .. automethod:: build_tokens_line
    .. automethod:: check_logical
+   .. automethod:: check_ast
    .. automethod:: generate_tokens
-   .. automethod:: check_all(expected=None, line_offset=1)
+   .. automethod:: check_all(expected=None, line_offset=0)
 
 
 .. _report_classes:
@@ -67,8 +67,6 @@ Report Classes
 
 .. autoclass:: DiffReport
 
-.. autoclass:: TestReport
-
 
 Utilities
 ---------
@@ -77,6 +75,7 @@ Utilities
 .. autofunction:: mute_string(text)
 .. autofunction:: read_config(options, args, arglist, parser)
 .. autofunction:: process_options(arglist=None, parse_argv=False, config_file=None)
+.. autofunction:: register_check(func_or_cls, codes=None)
 
 ..
   These ones are used internally, but they don't need advertising
@@ -85,6 +84,5 @@ Utilities
   .. autofunction:: stdin_get_value()
   .. autofunction:: parse_udiff(diff, patterns=None, parent='.')
   .. autofunction:: filename_match(filename, patterns, default=True)
-  .. autofunction:: find_checks(argument_name)
-  .. autofunction:: init_tests(pep8style)
-  .. autofunction:: selftest(options)
+  .. autofunction:: get_parser(prog='pep8', version=pep8.__version__)
+  .. autofunction:: init_checks_registry()