pywb/docs/code/pywb.utils.rst

pywb\.utils package
===================

Submodules
----------

pywb\.utils\.binsearch module
-----------------------------

.. automodule:: pywb.utils.binsearch
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.utils\.canonicalize module
--------------------------------

.. automodule:: pywb.utils.canonicalize
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.utils\.format module
--------------------------

.. automodule:: pywb.utils.format
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.utils\.geventserver module
--------------------------------

.. automodule:: pywb.utils.geventserver
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.utils\.io module
----------------------

.. automodule:: pywb.utils.io
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.utils\.loaders module
---------------------------

.. automodule:: pywb.utils.loaders
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.utils\.memento module
---------------------------

.. automodule:: pywb.utils.memento
    :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:
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`pywb\.utils package`
			`===================`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
			`Submodules`
			`----------`

New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`pywb\.utils\.binsearch module`
			`-----------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
			`.. automodule:: pywb.utils.binsearch`
			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`pywb\.utils\.canonicalize module`
			`--------------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.canonicalize`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`pywb\.utils\.format module`
			`--------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.format`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`pywb\.utils\.geventserver module`
			`--------------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.geventserver`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`pywb\.utils\.io module`
			`----------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.io`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`pywb\.utils\.loaders module`
			`---------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.loaders`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`pywb\.utils\.memento module`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`---------------------------`

New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.memento`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`pywb\.utils\.wbexception module`
			`-------------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
			`.. automodule:: pywb.utils.wbexception`
			`:members:`
			`:undoc-members:`
			`:show-inheritance:`


			`Module contents`
			`---------------`

			`.. automodule:: pywb.utils`
			`:members:`
			`:undoc-members:`
			`:show-inheritance:`