From 1829de212369c227ce9330aa197fbb38c777e181 Mon Sep 17 00:00:00 2001 From: Kenji Nagahashi Date: Fri, 7 Mar 2014 20:09:33 +0000 Subject: [PATCH] add API doc for all packages with sphinx-apidoc --- doc/index.rst | 74 ++++++++------------------------------- doc/modules.rst | 7 ++++ doc/pywb.apps.rst | 30 ++++++++++++++++ doc/pywb.cdx.rst | 76 ++++++++++++++++++++++++++++++++++++++++ doc/pywb.core.rst | 65 ++++++++++++++++++++++++++++++++++ doc/pywb.framework.rst | 67 +++++++++++++++++++++++++++++++++++ doc/pywb.perms.rst | 38 ++++++++++++++++++++ doc/pywb.rewrite.rst | 79 ++++++++++++++++++++++++++++++++++++++++++ doc/pywb.rst | 24 +++++++++++++ doc/pywb.utils.rst | 79 ++++++++++++++++++++++++++++++++++++++++++ doc/pywb.warc.rst | 39 +++++++++++++++++++++ 11 files changed, 519 insertions(+), 59 deletions(-) create mode 100644 doc/modules.rst create mode 100644 doc/pywb.apps.rst create mode 100644 doc/pywb.cdx.rst create mode 100644 doc/pywb.core.rst create mode 100644 doc/pywb.framework.rst create mode 100644 doc/pywb.perms.rst create mode 100644 doc/pywb.rewrite.rst create mode 100644 doc/pywb.rst create mode 100644 doc/pywb.utils.rst create mode 100644 doc/pywb.warc.rst diff --git a/doc/index.rst b/doc/index.rst index 9c90a3f7..932c0a60 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 +Customizing Pywb +---------------- + +Access Control ~~~~~~~~~~~~~~ -.. automodule:: pywb.cdx.query - :members: - :undoc-members: - :special-members: __call__ - -pywb.cdx.cdxops -~~~~~~~~~~~~~~~ - -.. automodule:: pywb.cdx.cdxops - :members: - :undoc-members: - :special-members: __call__ - -pywb.cdx.cdxdomainspecific -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. automodule:: pywb.cdx.cdxdomainspecific - :members: - :undoc-members: - :special-members: __call__ - -pywb.cdx.perms -~~~~~~~~~~~~~~ - -.. 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 ================== diff --git a/doc/modules.rst b/doc/modules.rst new file mode 100644 index 00000000..417a9afd --- /dev/null +++ b/doc/modules.rst @@ -0,0 +1,7 @@ +pywb +==== + +.. toctree:: + :maxdepth: 4 + + pywb diff --git a/doc/pywb.apps.rst b/doc/pywb.apps.rst new file mode 100644 index 00000000..35c5f111 --- /dev/null +++ b/doc/pywb.apps.rst @@ -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: diff --git a/doc/pywb.cdx.rst b/doc/pywb.cdx.rst new file mode 100644 index 00000000..d972c4de --- /dev/null +++ b/doc/pywb.cdx.rst @@ -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: diff --git a/doc/pywb.core.rst b/doc/pywb.core.rst new file mode 100644 index 00000000..55d59e85 --- /dev/null +++ b/doc/pywb.core.rst @@ -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: diff --git a/doc/pywb.framework.rst b/doc/pywb.framework.rst new file mode 100644 index 00000000..0a55d5f5 --- /dev/null +++ b/doc/pywb.framework.rst @@ -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: diff --git a/doc/pywb.perms.rst b/doc/pywb.perms.rst new file mode 100644 index 00000000..0de7fa72 --- /dev/null +++ b/doc/pywb.perms.rst @@ -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: diff --git a/doc/pywb.rewrite.rst b/doc/pywb.rewrite.rst new file mode 100644 index 00000000..1feb66a0 --- /dev/null +++ b/doc/pywb.rewrite.rst @@ -0,0 +1,79 @@ +pywb.rewrite package +==================== + +Submodules +---------- + +pywb.rewrite.header_rewriter module +----------------------------------- + +.. automodule:: pywb.rewrite.header_rewriter + :members: + :undoc-members: + :show-inheritance: + +pywb.rewrite.html_rewriter module +--------------------------------- + +.. automodule:: pywb.rewrite.html_rewriter + :members: + :undoc-members: + :show-inheritance: + +pywb.rewrite.regex_rewriters module +----------------------------------- + +.. automodule:: pywb.rewrite.regex_rewriters + :members: + :undoc-members: + :show-inheritance: + :special-members: __call__ + +pywb.rewrite.rewrite_content module +----------------------------------- + +.. automodule:: pywb.rewrite.rewrite_content + :members: + :undoc-members: + :show-inheritance: + +pywb.rewrite.rewrite_live module +-------------------------------- + +.. automodule:: pywb.rewrite.rewrite_live + :members: + :undoc-members: + :show-inheritance: + +pywb.rewrite.rewriterules module +-------------------------------- + +.. automodule:: pywb.rewrite.rewriterules + :members: + :undoc-members: + :show-inheritance: + +pywb.rewrite.url_rewriter module +-------------------------------- + +.. automodule:: pywb.rewrite.url_rewriter + :members: + :undoc-members: + :show-inheritance: + +pywb.rewrite.wburl module +------------------------- + +.. automodule:: pywb.rewrite.wburl + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pywb.rewrite + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/pywb.rst b/doc/pywb.rst new file mode 100644 index 00000000..dda76543 --- /dev/null +++ b/doc/pywb.rst @@ -0,0 +1,24 @@ +pywb package +============ + +Subpackages +----------- + +.. toctree:: + + pywb.apps + pywb.cdx + pywb.core + pywb.framework + pywb.perms + pywb.rewrite + pywb.utils + pywb.warc + +Module contents +--------------- + +.. automodule:: pywb + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/pywb.utils.rst b/doc/pywb.utils.rst new file mode 100644 index 00000000..8fdd5e49 --- /dev/null +++ b/doc/pywb.utils.rst @@ -0,0 +1,79 @@ +pywb.utils package +================== + +Submodules +---------- + +pywb.utils.binsearch module +--------------------------- + +.. automodule:: pywb.utils.binsearch + :members: + :undoc-members: + :show-inheritance: + +pywb.utils.bufferedreaders module +--------------------------------- + +.. automodule:: pywb.utils.bufferedreaders + :members: + :undoc-members: + :show-inheritance: + +pywb.utils.canonicalize module +------------------------------ + +.. automodule:: pywb.utils.canonicalize + :members: + :undoc-members: + :show-inheritance: + :special-members: __call__ + +pywb.utils.dsrules module +------------------------- + +.. automodule:: pywb.utils.dsrules + :members: + :undoc-members: + :show-inheritance: + +pywb.utils.loaders module +------------------------- + +.. automodule:: pywb.utils.loaders + :members: + :undoc-members: + :show-inheritance: + +pywb.utils.statusandheaders module +---------------------------------- + +.. automodule:: pywb.utils.statusandheaders + :members: + :undoc-members: + :show-inheritance: + +pywb.utils.timeutils module +--------------------------- + +.. automodule:: pywb.utils.timeutils + :members: + :undoc-members: + :show-inheritance: + +pywb.utils.wbexception module +----------------------------- + +.. automodule:: pywb.utils.wbexception + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pywb.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/pywb.warc.rst b/doc/pywb.warc.rst new file mode 100644 index 00000000..c5369cbd --- /dev/null +++ b/doc/pywb.warc.rst @@ -0,0 +1,39 @@ +pywb.warc package +================= + +Submodules +---------- + +pywb.warc.pathresolvers module +------------------------------ + +.. automodule:: pywb.warc.pathresolvers + :members: + :undoc-members: + :show-inheritance: + :special-members: __call__ + +pywb.warc.recordloader module +----------------------------- + +.. automodule:: pywb.warc.recordloader + :members: + :undoc-members: + :show-inheritance: + +pywb.warc.resolvingloader module +-------------------------------- + +.. automodule:: pywb.warc.resolvingloader + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pywb.warc + :members: + :undoc-members: + :show-inheritance: