Permalink
Browse files

add API doc for all packages with sphinx-apidoc

  • Loading branch information...
1 parent 702e5e0 commit 1829de212369c227ce9330aa197fbb38c777e181 @kngenie kngenie committed Mar 7, 2014
Showing with 518 additions and 58 deletions.
  1. +14 −58 doc/index.rst
  2. +7 −0 doc/modules.rst
  3. +30 −0 doc/pywb.apps.rst
  4. +76 −0 doc/pywb.cdx.rst
  5. +65 −0 doc/pywb.core.rst
  6. +67 −0 doc/pywb.framework.rst
  7. +38 −0 doc/pywb.perms.rst
  8. +79 −0 doc/pywb.rewrite.rst
  9. +24 −0 doc/pywb.rst
  10. +79 −0 doc/pywb.utils.rst
  11. +39 −0 doc/pywb.warc.rst
View
@@ -6,78 +6,34 @@
Welcome to pywb's documentation!
================================
-Contents:
+Pywb is a pure-Python implementation of Wayback Machine.
.. toctree::
:maxdepth: 2
-CDX Server (pywb.cdx)
----------------------
+Installing Pywb
+---------------
-pywb.cdx.cdxserver
-~~~~~~~~~~~~~~~~~~
+Pywb QuickStart
+---------------
-.. automodule:: pywb.cdx.cdxserver
- :members:
- :undoc-members:
- :special-members: __call__
+The pywb tool suite currently includes two runnable applications in the
+:mod:`pywb.apps` package::
-pywb.cdx.cdxsource
-~~~~~~~~~~~~~~~~~~
+ python -m pywb.apps.wayback
-.. automodule:: pywb.cdx.cdxsource
- :members:
- :undoc-members:
- :special-members: __call__
+starts the full wayback on port 8080, and::
-pywb.cdx.cdxobject
-~~~~~~~~~~~~~~~~~~
+ python -m pywb.apps.cdx_server
-.. automodule:: pywb.cdx.cdxobject
- :members:
- :undoc-members:
- :special-members: __call__
+starts standalone cdx server on port 8090
-pywb.cdx.query
-~~~~~~~~~~~~~~
-
-.. automodule:: pywb.cdx.query
- :members:
- :undoc-members:
- :special-members: __call__
-
-pywb.cdx.cdxops
-~~~~~~~~~~~~~~~
-
-.. automodule:: pywb.cdx.cdxops
- :members:
- :undoc-members:
- :special-members: __call__
+Customizing Pywb
+----------------
-pywb.cdx.cdxdomainspecific
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: pywb.cdx.cdxdomainspecific
- :members:
- :undoc-members:
- :special-members: __call__
-
-pywb.cdx.perms
+Access Control
~~~~~~~~~~~~~~
-.. automodule:: pywb.cdx.perms
- :members:
- :undoc-members:
- :special-members: __call__
-
-pywb.cdx.zipnum
-~~~~~~~~~~~~~~~
-
-.. automodule:: pywb.cdx.zipnum
- :members:
- :undoc-members:
- :special-members: __call__
-
Indices and tables
==================
View
@@ -0,0 +1,7 @@
+pywb
+====
+
+.. toctree::
+ :maxdepth: 4
+
+ pywb
View
@@ -0,0 +1,30 @@
+pywb.apps package
+=================
+
+Submodules
+----------
+
+pywb.apps.cdx_server module
+---------------------------
+
+.. automodule:: pywb.apps.cdx_server
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywb.apps.wayback module
+------------------------
+
+.. automodule:: pywb.apps.wayback
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pywb.apps
+ :members:
+ :undoc-members:
+ :show-inheritance:
View
@@ -0,0 +1,76 @@
+pywb.cdx package
+================
+
+Submodules
+----------
+
+pywb.cdx.cdxdomainspecific module
+---------------------------------
+
+.. automodule:: pywb.cdx.cdxdomainspecific
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.cdx.cdxobject module
+-------------------------
+
+.. automodule:: pywb.cdx.cdxobject
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.cdx.cdxops module
+----------------------
+
+.. automodule:: pywb.cdx.cdxops
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.cdx.cdxserver module
+-------------------------
+
+.. automodule:: pywb.cdx.cdxserver
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.cdx.cdxsource module
+-------------------------
+
+.. automodule:: pywb.cdx.cdxsource
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.cdx.query module
+---------------------
+
+.. automodule:: pywb.cdx.query
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.cdx.zipnum module
+----------------------
+
+.. automodule:: pywb.cdx.zipnum
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pywb.cdx
+ :members:
+ :undoc-members:
+ :show-inheritance:
View
@@ -0,0 +1,65 @@
+pywb.core package
+=================
+
+Submodules
+----------
+
+pywb.core.cdx_handler module
+----------------------------
+
+.. automodule:: pywb.core.cdx_handler
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.core.handlers module
+-------------------------
+
+.. automodule:: pywb.core.handlers
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.core.indexreader module
+----------------------------
+
+.. automodule:: pywb.core.indexreader
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywb.core.pywb_init module
+--------------------------
+
+.. automodule:: pywb.core.pywb_init
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywb.core.replay_views module
+-----------------------------
+
+.. automodule:: pywb.core.replay_views
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.core.views module
+----------------------
+
+.. automodule:: pywb.core.views
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pywb.core
+ :members:
+ :undoc-members:
+ :show-inheritance:
@@ -0,0 +1,67 @@
+pywb.framework package
+======================
+
+Submodules
+----------
+
+pywb.framework.archivalrouter module
+------------------------------------
+
+.. automodule:: pywb.framework.archivalrouter
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.framework.basehandlers module
+----------------------------------
+
+.. automodule:: pywb.framework.basehandlers
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.framework.proxy module
+---------------------------
+
+.. automodule:: pywb.framework.proxy
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.framework.wbexceptions module
+----------------------------------
+
+.. automodule:: pywb.framework.wbexceptions
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywb.framework.wbrequestresponse module
+---------------------------------------
+
+.. automodule:: pywb.framework.wbrequestresponse
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+pywb.framework.wsgi_wrappers module
+-----------------------------------
+
+.. automodule:: pywb.framework.wsgi_wrappers
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+
+Module contents
+---------------
+
+.. automodule:: pywb.framework
+ :members:
+ :undoc-members:
+ :show-inheritance:
View
@@ -0,0 +1,38 @@
+pywb.perms package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+
+ pywb.perms.test
+
+Submodules
+----------
+
+pywb.perms.perms_filter module
+------------------------------
+
+.. automodule:: pywb.perms.perms_filter
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+pywb.perms.perms_handler module
+-------------------------------
+
+.. automodule:: pywb.perms.perms_handler
+ :members:
+ :undoc-members:
+ :show-inheritance:
+ :special-members: __call__
+
+
+Module contents
+---------------
+
+.. automodule:: pywb.perms
+ :members:
+ :undoc-members:
+ :show-inheritance:
Oops, something went wrong.

0 comments on commit 1829de2

Please sign in to comment.