From 87c20373b4ab4f2bf5be4cc7c079521812195044 Mon Sep 17 00:00:00 2001 From: Joe Jevnik Date: Fri, 6 May 2016 15:32:48 -0400 Subject: [PATCH] DOC: document that docs should be built with py3 --- docs/source/release-process.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/release-process.rst b/docs/source/release-process.rst index ee59b8fb..e766d678 100644 --- a/docs/source/release-process.rst +++ b/docs/source/release-process.rst @@ -161,6 +161,13 @@ latest master and run: This will build the documentation, checkout a fresh copy of the ``gh-pages`` git branch, and copy the built docs into the zipline root. +.. note:: + + The docs should always be built with **Python 3**. Many of our api functions + are wrapped by preprocessing functions which accept \*args and \**kwargs. In + Python 3, sphinx will respect the ``__wrapped__`` attribute and display the + correct arguments. + Now, using our browser of choice, view the ``index.html`` page and verify that the docs look correct.