Make doc styler detect lists on rst (#9488)

8d25df2c · Sylvain Gugger · GitHub · 5a442a8d · 8d25df2c · 8d25df2c
Unverified Commit 8d25df2c authored Jan 11, 2021 by Sylvain Gugger Committed by GitHub Jan 11, 2021
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 2 deletions

docs/source/benchmarks.rst docs/source/benchmarks.rst +4 -0

utils/style_doc.py utils/style_doc.py +2 -2

No files found.
--- a/docs/source/benchmarks.rst
+++ b/docs/source/benchmarks.rst
@@ -99,6 +99,7 @@ An instantiated benchmark object can then simply be run by calling ``benchmark.r
    --------------------------------------------------------------------------------

    ====================        ENVIRONMENT INFORMATION         ====================
+
    - transformers_version: 2.11.0
    - framework: PyTorch
    - use_torchscript: False
@@ -145,6 +146,7 @@ An instantiated benchmark object can then simply be run by calling ``benchmark.r
    --------------------------------------------------------------------------------

    ====================        ENVIRONMENT INFORMATION         ====================
+
    - transformers_version: 2.11.0
    - framework: Tensorflow
    - use_xla: False
@@ -228,6 +230,7 @@ configurations must be inserted with the benchmark args as follows.
    --------------------------------------------------------------------------------

    ====================        ENVIRONMENT INFORMATION         ====================
+
    - transformers_version: 2.11.0
    - framework: PyTorch
    - use_torchscript: False
@@ -297,6 +300,7 @@ configurations must be inserted with the benchmark args as follows.
    --------------------------------------------------------------------------------

    ====================        ENVIRONMENT INFORMATION         ====================
+
    - transformers_version: 2.11.0
    - framework: Tensorflow
    - use_xla: False

--- a/utils/style_doc.py
+++ b/utils/style_doc.py
@@ -381,9 +381,9 @@ def style_rst_file(doc_file, max_len=119, check_only=False):
        doc = f.read()

    # Add missing new lines before lists
-    doc = _add_new_lines_before_list(doc)
+    clean_doc = _add_new_lines_before_list(doc)
    # Style
-    clean_doc = rst_styler.style(doc, max_len=max_len)
+    clean_doc = rst_styler.style(clean_doc, max_len=max_len)

    diff = clean_doc != doc
    if not check_only and diff: