Turn on dangling-reference warning in sphinx for local builds.

Reformat the HTTPFile docs where were causing odd reference errors.
lisiyuan · Mar 16, 2013 · e4feeba · e4feeba
1 parent ae61c71
commit e4feeba
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,4 +1,4 @@
-SPHINXOPTS=-W -d build/doctrees .
+SPHINXOPTS=-n -W -d build/doctrees .
 
 .PHONY: sphinx
 sphinx:

diff --git a/tornado/httputil.py b/tornado/httputil.py
@@ -216,10 +216,9 @@ class HTTPFile(ObjectDict):
     """Represents an HTTP file. For backwards compatibility, its instance
     attributes are also accessible as dictionary keys.
 
-    :ivar filename:
-    :ivar body:
-    :ivar content_type: The content_type comes from the provided HTTP header
-        and should not be trusted outright given that it can be easily forged.
+    * ``filename``
+    * ``body``
+    * ``content_type``
     """
     pass