diff --git a/docs/zipline.rst b/docs/zipline.rst new file mode 100644 index 00000000..cd7def87 --- /dev/null +++ b/docs/zipline.rst @@ -0,0 +1,43 @@ +zipline Package +=============== + +:mod:`zipline` Package +---------------------- + +.. automodule:: zipline.__init__ + :members: + :undoc-members: + :show-inheritance: + +:mod:`messaging` Module +----------------------- + +.. automodule:: zipline.messaging + :members: + :undoc-members: + :show-inheritance: + +:mod:`sources` Module +--------------------- + +.. automodule:: zipline.sources + :members: + :undoc-members: + :show-inheritance: + +:mod:`util` Module +------------------ + +.. automodule:: zipline.util + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + zipline.test + zipline.transforms + diff --git a/docs/zipline.test.rst b/docs/zipline.test.rst new file mode 100644 index 00000000..5521f57e --- /dev/null +++ b/docs/zipline.test.rst @@ -0,0 +1,19 @@ +test Package +============ + +:mod:`client` Module +-------------------- + +.. automodule:: zipline.test.client + :members: + :undoc-members: + :show-inheritance: + +:mod:`test_messaging` Module +---------------------------- + +.. automodule:: zipline.test.test_messaging + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/zipline.transforms.rst b/docs/zipline.transforms.rst new file mode 100644 index 00000000..aaf57f49 --- /dev/null +++ b/docs/zipline.transforms.rst @@ -0,0 +1,19 @@ +transforms Package +================== + +:mod:`transforms` Package +------------------------- + +.. automodule:: zipline.transforms + :members: + :undoc-members: + :show-inheritance: + +:mod:`technical` Module +----------------------- + +.. automodule:: zipline.transforms.technical + :members: + :undoc-members: + :show-inheritance: + diff --git a/pavement.py b/pavement.py index 0fd32fd3..5bb20e66 100644 --- a/pavement.py +++ b/pavement.py @@ -185,4 +185,5 @@ def apidocs(): Recursively autogenerate the Sphinx autodoc for the module and its submodules. """ + call('rm docs/zipline.*.rst', shell=True) call('sphinx-apidoc -o docs/ zipline', shell=True)