document classes, functions, exceptions (#82)

diff --git a/docs/conf.py b/docs/conf.py
index 6edddba729f753803168911347ee22b68c5cedb4..908a1a7e69250b0579ccfa48f306b1e615278d9e 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -112,6 +112,7 @@ 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.

diff --git a/docs/index.rst b/docs/index.rst
index 9422402956649b5903df3167e456341d1c50f22c..a293019606b1b6bcb6f0517c59d454f6e061a572 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -51,9 +51,9 @@ Contents
    editor_integration
    contributing
    change_log
+   reference/reference_summary
    authors
 
-
 Indices and tables
 ==================
 

diff --git a/docs/reference/reference_classes.rst b/docs/reference/reference_classes.rst
new file mode 100644 (file)
index 0000000..ee490d3
--- /dev/null
+++ b/docs/reference/reference_classes.rst
@@ -0,0 +1,44 @@
+*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:
+
+

diff --git a/docs/reference/reference_exceptions.rst b/docs/reference/reference_exceptions.rst
new file mode 100644 (file)
index 0000000..bd65412
--- /dev/null
+++ b/docs/reference/reference_exceptions.rst
@@ -0,0 +1,12 @@
+*Black* exceptions
+==================
+
+*Contents are subject to change.*
+
+.. currentmodule:: black
+
+.. autoexception:: black.CannotSplit
+
+.. autoexception:: black.FormatError
+
+.. autoexception:: black.NothingChanged

diff --git a/docs/reference/reference_functions.rst b/docs/reference/reference_functions.rst
new file mode 100644 (file)
index 0000000..f9cd505
--- /dev/null
+++ b/docs/reference/reference_functions.rst
@@ -0,0 +1,74 @@
+*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

diff --git a/docs/reference/reference_summary.rst b/docs/reference/reference_summary.rst
new file mode 100644 (file)
index 0000000..780a4b4
--- /dev/null
+++ b/docs/reference/reference_summary.rst
@@ -0,0 +1,11 @@
+Developer reference
+===================
+
+*Contents are subject to change.*
+
+.. toctree::
+   :maxdepth: 2
+
+   reference_classes
+   reference_functions
+   reference_exceptions