mirror of
https://github.com/webrecorder/pywb.git
synced 2025-03-15 00:03:28 +01:00
add API doc for all packages with sphinx-apidoc
This commit is contained in:
Kenji Nagahashi
parent
702e5e0143
commit
1829de2123
@ -6,78 +6,34 @@
|
|||||||
Welcome to pywb's documentation!
|
Welcome to pywb's documentation!
|
||||||
================================
|
================================
|
||||||
|
|
||||||
Contents:
|
Pywb is a pure-Python implementation of Wayback Machine.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
CDX Server (pywb.cdx)
|
Installing Pywb
|
||||||
---------------------
|
---------------
|
||||||
|
|
||||||
pywb.cdx.cdxserver
|
Pywb QuickStart
|
||||||
~~~~~~~~~~~~~~~~~~
|
---------------
|
||||||
|
|
||||||
.. automodule:: pywb.cdx.cdxserver
|
The pywb tool suite currently includes two runnable applications in the
|
||||||
:members:
|
:mod:`pywb.apps` package::
|
||||||
:undoc-members:
|
|
||||||
:special-members: __call__
|
|
||||||
|
|
||||||
pywb.cdx.cdxsource
|
python -m pywb.apps.wayback
|
||||||
~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. automodule:: pywb.cdx.cdxsource
|
starts the full wayback on port 8080, and::
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:special-members: __call__
|
|
||||||
|
|
||||||
pywb.cdx.cdxobject
|
python -m pywb.apps.cdx_server
|
||||||
~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. automodule:: pywb.cdx.cdxobject
|
starts standalone cdx server on port 8090
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:special-members: __call__
|
|
||||||
|
|
||||||
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
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|||||||
7
doc/modules.rst
Normal file
7
doc/modules.rst
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
pywb
|
||||||
|
====
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
|
||||||
|
pywb
|
||||||
30
doc/pywb.apps.rst
Normal file
30
doc/pywb.apps.rst
Normal file
@ -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:
|
||||||
76
doc/pywb.cdx.rst
Normal file
76
doc/pywb.cdx.rst
Normal file
@ -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:
|
||||||
65
doc/pywb.core.rst
Normal file
65
doc/pywb.core.rst
Normal file
@ -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:
|
||||||
67
doc/pywb.framework.rst
Normal file
67
doc/pywb.framework.rst
Normal file
@ -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:
|
||||||
38
doc/pywb.perms.rst
Normal file
38
doc/pywb.perms.rst
Normal file
@ -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:
|
||||||
79
doc/pywb.rewrite.rst
Normal file
79
doc/pywb.rewrite.rst
Normal file
@ -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:
|
||||||
24
doc/pywb.rst
Normal file
24
doc/pywb.rst
Normal file
@ -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:
|
||||||
79
doc/pywb.utils.rst
Normal file
79
doc/pywb.utils.rst
Normal file
@ -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:
|
||||||
39
doc/pywb.warc.rst
Normal file
39
doc/pywb.warc.rst
Normal file
@ -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:
|
||||||
Loading…
x
Reference in New Issue
Block a user