Commit a9f50cd0 authored by Carol Willing's avatar Carol Willing Committed by Łukasz Langa
Browse files

document classes, functions, exceptions (#82)

parent 10bb45c3
Loading
Loading
Loading
Loading
+1 −0
Changes for docs/conf.py: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -112,6 +112,7 @@ def generate_sections_from_readme():
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.napoleon',
]

# Add any paths that contain templates here, relative to this directory.
+1 −1
Changes for docs/index.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -51,9 +51,9 @@ Contents
   editor_integration
   contributing
   change_log
   reference/reference_summary
   authors


Indices and tables
==================

+44 −0
Changes for docs/reference/reference_classes.rst: 44 added lines, 0 removed lines.
Original line number Diff line number Diff line
*Black* classes
===============

*Contents are subject to change.*

.. currentmodule:: black

:class:`EmptyLineTracker`
-------------------------

.. autoclass:: black.EmptyLineTracker
   :members:

:class:`FormatOn`
-----------------

.. autoclass:: black.FormatOn
   :members:

:class:`FormatOff`
------------------

.. autoclass:: black.FormatOff
    :members:

:class:`LineGenerator`
----------------------

.. autoclass:: black.LineGenerator
    :members:

:class:`Report`
---------------

.. autoclass:: black.Report
    :members:

:class:`Visitor`
----------------------

.. autoclass:: black.Visitor
    :members:

+12 −0
Changes for docs/reference/reference_exceptions.rst: 12 added lines, 0 removed lines.
Original line number Diff line number Diff line
*Black* exceptions
==================

*Contents are subject to change.*

.. currentmodule:: black

.. autoexception:: black.CannotSplit

.. autoexception:: black.FormatError

.. autoexception:: black.NothingChanged
+74 −0
Changes for docs/reference/reference_functions.rst: 74 added lines, 0 removed lines.
Original line number Diff line number Diff line
*Black* functions
=================

*Contents are subject to change.*

.. currentmodule:: black

Assertions and checks
---------------------

.. autofunction:: black.assert_equivalent

.. autofunction:: black.assert_stable

.. autofunction:: black.is_delimiter

.. autofunction:: black.is_import

.. autofunction:: black.is_python36

Formatting
----------

.. autofunction:: black.format_file_contents

.. autofunction:: black.format_file_in_place

.. autofunction:: black.format_stdin_to_stdout

.. autofunction:: black.format_str

.. autofunction:: black.schedule_formatting

File operations
---------------

.. autofunction:: black.dump_to_file

.. autofunction:: black.gen_python_files_in_dir

Parsing
-------

.. autofunction:: black.lib2to3_parse

.. autofunction:: black.lib2to3_unparse

Split functions
---------------

.. autofunction:: black.delimiter_split

.. autofunction:: black.left_hand_split

.. autofunction:: black.right_hand_split

.. autofunction:: black.split_line

.. autofunction:: black.split_succeeded_or_raise

Utilities
---------

.. autofunction:: black.diff

.. autofunction:: black.generate_comments

.. autofunction:: black.make_comment

.. autofunction:: black.normalize_prefix

.. autofunction:: black.preceding_leaf

.. autofunction:: black.whitespace
 No newline at end of file
Loading