Add documentation

jnothman · jnothman · commit 6d5d44930358 · 2018-03-28T23:45:13.000+11:00
diff --git a/doc/index.rst b/doc/index.rst
@@ -22,3 +22,4 @@ Documentation
     install
     format
     example
+    validation
diff --git a/doc/validation.rst b/doc/validation.rst
@@ -0,0 +1,12 @@
+==============================
+Validating NumpyDoc docstrings
+==============================
+
+One tool for validating docstrings is to see how an object's dosctring
+translates to Restructured Text.  Using numpydoc as a command-line tool
+facilitates this. For example to see the Restructured Text generated
+for ``numpy.ndarray``, use:
+
+.. code-block:: bash
+
+    $ python -m numpydoc numpy.ndarray

-Original file line number
+Diff line change
     install
     format
     example
 +    validation