Auto-generated documentation-related fixes

psf · Mar 29, 2018 · d01460d · d01460d
1 parent a9f50cd
commit d01460d
Show file tree

Hide file tree

Showing 14 changed files with 172 additions and 46 deletions.
diff --git a/black.py b/black.py
diff --git a/docs/authors.md b/docs/authors.md
@@ -1 +1 @@
-/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/authors.md
+_build/generated/authors.md
diff --git a/docs/change_log.md b/docs/change_log.md
@@ -1 +1 @@
-/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/change_log.md
+_build/generated/change_log.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -59,6 +59,7 @@ def generate_sections_from_readme():
     target_dir.mkdir(parents=True)
 
     output = None
+    target_dir = target_dir.relative_to(CURRENT_DIR)
     with open(str(readme), 'r', encoding='utf8') as f:
         for line in f:
             if line.startswith('## '):

diff --git a/docs/contributing_to_black.md b/docs/contributing_to_black.md
@@ -1 +1 @@
-/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/contributing_to_black.md
+_build/generated/contributing_to_black.md
diff --git a/docs/editor_integration.md b/docs/editor_integration.md
@@ -1 +1 @@
-/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/editor_integration.md
+_build/generated/editor_integration.md
diff --git a/docs/installation_and_usage.md b/docs/installation_and_usage.md
@@ -1 +1 @@
-/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/installation_and_usage.md
+_build/generated/installation_and_usage.md
diff --git a/docs/license.md b/docs/license.md
@@ -1 +1 @@
-/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/license.md
+_build/generated/license.md
diff --git a/docs/reference/reference_classes.rst b/docs/reference/reference_classes.rst
@@ -5,26 +5,26 @@
 
 .. currentmodule:: black
 
-:class:`EmptyLineTracker`
+:class:`BracketTracker`
 -------------------------
 
-.. autoclass:: black.EmptyLineTracker
+.. autoclass:: black.BracketTracker
    :members:
 
-:class:`FormatOn`
------------------
+:class:`EmptyLineTracker`
+-------------------------
 
-.. autoclass:: black.FormatOn
+.. autoclass:: black.EmptyLineTracker
    :members:
 
-:class:`FormatOff`
-------------------
+:class:`Line`
+-------------
 
-.. autoclass:: black.FormatOff
+.. autoclass:: black.Line
     :members:
 
-:class:`LineGenerator`
-----------------------
+:class:`LineGenerator` (:class:`Visitor` [:class:`Line`])
+-------------------------------------------------------
 
 .. autoclass:: black.LineGenerator
     :members:
@@ -35,10 +35,14 @@
 .. autoclass:: black.Report
     :members:
 
-:class:`Visitor`
-----------------------
+:class:`UnformattedLines` (:class:`Line`)
+----------------------------------------
 
-.. autoclass:: black.Visitor
+.. autoclass:: black.UnformattedLines
     :members:
 
+:class:`Visitor` (Generic[T])
+----------------------------
 
+.. autoclass:: black.Visitor
+    :members:
diff --git a/docs/reference/reference_exceptions.rst b/docs/reference/reference_exceptions.rst
@@ -9,4 +9,8 @@
 
 .. autoexception:: black.FormatError
 
+.. autoexception:: black.FormatOn
+
+.. autoexception:: black.FormatOff
+
 .. autoexception:: black.NothingChanged
diff --git a/docs/reference/reference_functions.rst b/docs/reference/reference_functions.rst
@@ -56,7 +56,7 @@ Split functions
 
 .. autofunction:: black.split_line
 
-.. autofunction:: black.split_succeeded_or_raise
+.. autofunction:: black.bracket_split_succeeded_or_raise
 
 Utilities
 ---------
@@ -71,4 +71,4 @@ Utilities
 
 .. autofunction:: black.preceding_leaf
 
-.. autofunction:: black.whitespace
+.. autofunction:: black.whitespace
diff --git a/docs/show_your_style.md b/docs/show_your_style.md
@@ -1 +1 @@
-/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/show_your_style.md
+_build/generated/show_your_style.md
diff --git a/docs/testimonials.md b/docs/testimonials.md
@@ -1 +1 @@
-/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/testimonials.md
+_build/generated/testimonials.md
diff --git a/docs/the_black_code_style.md b/docs/the_black_code_style.md
@@ -1 +1 @@
-/Users/ambv/Dropbox (Personal)/Python/black/docs/_build/generated/the_black_code_style.md
+_build/generated/the_black_code_style.md