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 7a0995bb78136ebea5159c2bca6d91aed12448c5..f03d247d949a6313adb6d0dfcd50d43d1064807d 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,7 +4,7 @@
 The uncompromising code formatter
 =================================
 
-By using *Black*, you agree to cease control over minutiae of
+By using *Black*, you agree to cede control over minutiae of
 hand-formatting. In return, *Black* gives you speed, determinism, and
 freedom from `pycodestyle` nagging about formatting. You will save time
 and mental energy for more important matters.
@@ -14,9 +14,11 @@ 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.
 
+Try it out now using the `Black Playground <https://black.now.sh>`_.
+
 .. note::
 
-   `Black is an early pre-release <usage.html#note-this-tool-is-alpha-quality-at-the-moment>`_.
+   `Black is beta <installation_and_usage.html#note-this-is-a-beta-product>`_.
 
 
 Testimonials
@@ -26,7 +28,7 @@ Testimonials
 
    *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!*
@@ -46,15 +48,24 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   usage
-   technical_philosophy
-   contributing
-   changelog
-
+   installation_and_usage
+   the_black_code_style
+   pyproject_toml
+   compatible_configs
+   editor_integration
+   blackd
+   black_primer
+   version_control_integration
+   github_actions
+   ignoring_unmodified_files
+   contributing_to_black
+   show_your_style
+   change_log
+   reference/reference_summary
+   authors
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`