mirror of
https://github.com/wassname/catalyst.git
synced 2026-07-17 11:25:55 +08:00
DOC: document that docs should be built with py3
This commit is contained in:
@@ -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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user