Update readme, docs, and docs requirements

marshmallow-code · Oct 2, 2015 · 1d4ad23 · 1d4ad23
1 parent b6a7c5b
commit 1d4ad23
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 14 deletions.
diff --git a/README.rst b/README.rst
@@ -5,12 +5,18 @@ apispec
 .. image:: https://travis-ci.org/marshmallow-code/apispec.svg?branch=dev
     :target: https://travis-ci.org/marshmallow-code/apispec
 
-**WARNING: Somewhat experimental. Caveat emptor.**
-
 A pluggable API documentation generator. Currently supports the `Swagger 2.0 specification <http://swagger.io/specification/>`_.
 
+Features
+========
+
+- Supports Swagger 2.0
+- Framework-agnostic
+- Includes plugins for marshmallow and Flask
+- Utilities for parsing docstrings
+
 Example application
--------------------
+===================
 
 .. code-block:: python
 
@@ -65,7 +71,7 @@ Example application
 
 
 Generated Swagger spec
-----------------------
+======================
 
 .. code-block:: python
 
@@ -124,14 +130,12 @@ Generated Swagger spec
     # }
 
 
+Documentation
+-------------
 
-
-.. Documentation
-.. -------------
-
-.. Documentation is available at http://apispec.readthedocs.org/ .
+Documentation is available at http://apispec.readthedocs.org/ .
 
 License
--------
+=======
 
 MIT licensed. See the bundled `LICENSE <https://github.com/marshmallow-code/apispec/blob/master/LICENSE>`_ file for more details.
diff --git a/apispec/ext/flask.py b/apispec/ext/flask.py
@@ -1,4 +1,7 @@
 # -*- coding: utf-8 -*-
+"""Flask plugin. Includes a path helper that allows you to pass a view
+function to `add_path`.
+"""
 from __future__ import absolute_import
 import re
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,11 +6,16 @@ Release v\ |version| (:ref:`Changelog <changelog>`)
 
 A pluggable API documentation generator. Currently supports the `Swagger 2.0 specification <http://swagger.io/specification/>`_.
 
-- `apispec @ GitHub <https://github.com/marshmallow-code/apispec>`_
-- `Issue Tracker <https://github.com/marshmallow-code/apispec/issues>`_
+Features
+========
+
+- Supports Swagger 2.0
+- Framework-agnostic
+- Includes plugins for marshmallow and Flask
+- Utilities for parsing docstrings
 
 Example application
--------------------
+===================
 
 .. code-block:: python
 
@@ -124,14 +129,18 @@ Generated Swagger spec
     # }
 
 API Reference
--------------
+=============
 
 .. toctree::
     :maxdepth: 2
 
     api_reference
 
+Project Links
+=============
 
+- `apispec @ GitHub <https://github.com/marshmallow-code/apispec>`_
+- `Issue Tracker <https://github.com/marshmallow-code/apispec/issues>`_
 
 Project Info
 ============

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
+marshmallow
 sphinx
 sphinx-rtd-theme