]> git.madduck.net Git - etc/vim.git/blobdiff - docs/index.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Don't omit escaping the second consecutive quote
[etc/vim.git] / docs / index.rst
index 0106c9cfdc8d555bfa494f25aff25b9a6be54f84..d014ed8a7ac6fae4cd2ed5980d361e4be7acd0e1 100644 (file)
@@ -1,16 +1,13 @@
 .. black documentation master file, created by
    sphinx-quickstart on Fri Mar 23 10:53:30 2018.
 
-Black
-=====
+The uncompromising code formatter
+=================================
 
-**Black** is the uncompromising Python code formatter. 
-
-By using *Black*, you
-agree to cease 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.
+By using *Black*, you agree to cease 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.
 
 *Black* makes code review faster by producing the smallest diffs
 possible. Blackened code looks the same regardless of the project
@@ -19,7 +16,7 @@ can focus on the content instead.
 
 .. note::
 
-   Black is an early pre-release.
+   `Black is an early pre-release <installation_and_usage.html#note-this-is-an-early-pre-release>`_.
 
 
 Testimonials
@@ -49,11 +46,14 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   usage
-   technical_philosophy
-   contributors_guide
-   changelog
-   
+   installation_and_usage
+   the_black_code_style
+   editor_integration
+   version_control_integration 
+   contributing
+   change_log
+   reference/reference_summary
+   authors
 
 Indices and tables
 ==================