Upgrade docs to Sphinx 3+ and add doc build test (#1613)

[etc/vim.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 30c24a3ab52810d85294ebe6055bb6ef06b43786..f03d247d949a6313adb6d0dfcd50d43d1064807d 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,6 +14,8 @@ possible. Blackened code looks the same regardless of the project
 you're reading. Formatting becomes transparent after a while and you
 can focus on the content instead.
 
 you're reading. Formatting becomes transparent after a while and you
 can focus on the content instead.
 

+Try it out now using the `Black Playground <https://black.now.sh>`_.
+

 .. note::
 
    `Black is beta <installation_and_usage.html#note-this-is-a-beta-product>`_.
 .. note::
 
    `Black is beta <installation_and_usage.html#note-this-is-a-beta-product>`_.


@@ -26,7 +28,7 @@ Testimonials
 
    *Black is opinionated so you don't have to be.*
 
 
    *Black is opinionated so you don't have to be.*
 

-**Hynek Schlawack**, creator of `attrs <http://www.attrs.org/>`_, core
+**Hynek Schlawack**, creator of `attrs <https://www.attrs.org/>`_, core

 developer of Twisted and CPython:
 
    *An auto-formatter that doesn't suck is all I want for Xmas!*
 developer of Twisted and CPython:
 
    *An auto-formatter that doesn't suck is all I want for Xmas!*


@@ -48,10 +50,16 @@ Contents
 
    installation_and_usage
    the_black_code_style
 
    installation_and_usage
    the_black_code_style

+   pyproject_toml
+   compatible_configs

    editor_integration
    editor_integration

+   blackd
+   black_primer

    version_control_integration
    version_control_integration

+   github_actions

    ignoring_unmodified_files
    ignoring_unmodified_files

-   contributing
+   contributing_to_black
+   show_your_style

    change_log
    reference/reference_summary
    authors
    change_log
    reference/reference_summary
    authors


@@ -60,5 +68,4 @@ Indices and tables
 ==================
 
 * :ref:`genindex`
 ==================
 
 * :ref:`genindex`

-* :ref:`modindex`

 * :ref:`search`
 * :ref:`search`