better framework Documentation

[bicepjai]

Dear Zipline Maintainers,

Before I tell you about my issue, let me describe my environment:

Environment

• Operating System: Darwin bicepjai-mac.local 15.4.0 Darwin Kernel Version 15.4.0: Fri Feb 26 22:08:05 PST 2016; root:xnu-3248.40.184~3/RELEASE_X86_64 x86_64
• Python Version: Python 2.7.11
• Python Bitness: 64
• How did you install Zipline: pip
• Python packages: bcolz==0.12.1 Bottleneck==1.0.0 cachetools==1.1.5 click==4.0 contextlib2==0.4.0 cyordereddict==0.2.2 Cython==0.22.1 decorator==4.0.0 epydoc==3.0.1 intervaltree==2.1.0 Logbook==0.12.5 multipledispatch==0.4.8 networkx==1.9.1 numexpr==2.4.6 numpy==1.11.0 pandas==0.16.1 pandas-datareader==0.2.1 patsy==0.4.0 python-dateutil==2.4.2 pytz==2015.4 requests==2.9.1 requests-file==1.4 scipy==0.15.1 six==1.10.0 sortedcontainers==1.4.4 SQLAlchemy==1.0.8 statsmodels==0.6.1 toolz==0.7.4 zipline==1.0.0

Now that you know a little about me, let me tell you about the issue I am having: I am trying to understand the framework better such as class hierarchies and as such.

Description of Issue

when i run

(master)[zipline]$ PYTHONPATH=. && epydoc --pdf zipline

• What did you expect to happen? generate document
• What happened instead?

(master)*[zipline]$ PYTHONPATH=. && epydoc --pdf zipline
+-----------------------------------------------------------------------------------------
| In /Users/bicepjai/Projects/softwares/zipline/zipline/__init__.py:
| Source code parsing failed (but introspection was successful).
|     Error: Error during parsing: invalid syntax (/Users/bicepjai/Projects/softwares/
|            zipline/zipline/__init__.py, line 19) -- Attempted relative import in
|            non-package, or beyond toplevel package
|
+-----------------------------------------------------------------------------------------
| In /Users/bicepjai/Projects/softwares/zipline/zipline/dispatch.py:
| Import failed (but source code parsing was successful).
|     Error: NameError: name 'namespace' is not defined (line 19)
|
Warning: Unable to extract the base list for zipline.finance.execution.ExecutionStyle: Bad
         dotted name
Warning: Unable to extract the base list for zipline.finance.cancel_policy.CancelPolicy:
         Bad dotted name
Warning: Unable to extract the base list for zipline.finance.slippage.SlippageModel: Bad
         dotted name
Warning: Unable to extract the base list for zipline.finance.controls.TradingControl: Bad
         dotted name
Warning: Unable to extract the base list for zipline.finance.controls.AccountControl: Bad
         dotted name
Warning: Unable to extract the base list for zipline.pipeline.engine.PipelineEngine: Bad
         dotted name
Warning: Unable to extract the base list for zipline.pipeline.term.Term: Bad dotted name
      00:03                                 Progress:                                 01:46
  3% [===----------------------------------------------------------------------------------]
      Building documentation: zipline.pipeline.term (/Users/bicepjai/Projects/softwares/...

UNEXPECTED ERROR:
data type not understood

Use --debug to see trace information.

Here is how you can reproduce this issue on your machine:

Reproduction Steps

1. goto zipline folder
2. just try running epydoc --pdf zipline

   What steps have you taken to resolve this already?

im trying to reach out to the community

Sincerely, jay

[llllllllll]

For Zipline we use sphinx to generate our docs. This is what you see on zipline.io. If you would like to build the docs locally, you can cd into docs/ and run make html and then open up the pages with $BROWSER build/html/index.html

[bicepjai]

Thanks. I was looking for more like module explanations like lean-block-diagrams and class hierarchy uml diagrams.