pywb/docs/code/pywb.warcserver.rst

pywb\.warcserver package
========================

Subpackages
-----------

.. toctree::

    pywb.warcserver.index
    pywb.warcserver.resource

Submodules
----------

pywb\.warcserver\.access\_checker module
----------------------------------------

.. automodule:: pywb.warcserver.access_checker
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.warcserver\.amf module
----------------------------

.. automodule:: pywb.warcserver.amf
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.warcserver\.basewarcserver module
---------------------------------------

.. automodule:: pywb.warcserver.basewarcserver
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.warcserver\.handlers module
---------------------------------

.. automodule:: pywb.warcserver.handlers
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.warcserver\.http module
-----------------------------

.. automodule:: pywb.warcserver.http
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.warcserver\.inputrequest module
-------------------------------------

.. automodule:: pywb.warcserver.inputrequest
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.warcserver\.upstreamindexsource module
--------------------------------------------

.. automodule:: pywb.warcserver.upstreamindexsource
    :members:
    :undoc-members:
    :show-inheritance:

pywb\.warcserver\.warcserver module
-----------------------------------

.. automodule:: pywb.warcserver.warcserver
    :members:
    :undoc-members:
    :show-inheritance:


Module contents
---------------

.. automodule:: pywb.warcserver
    :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\.warcserver package`
			`========================`

			`Subpackages`
			`-----------`

			`.. toctree::`

			`pywb.warcserver.index`
			`pywb.warcserver.resource`

			`Submodules`
			`----------`

Docs, custom metadata improvements (#509) * metadata/coll_config: don't confuse user metadata with collection config, don't display collection config settings as metadata (ukwa/ukwa-pywb#47) - for collection template, add separate 'coll_config' dict, keep user metadata only in 'metadata' dict (default to empty) - for static collections, assume metadata is in the 'metadata' dict of collection config - for dynamic collections, load metadata.yaml into 'metadata' dict - ensure 'metadata' key is passed to frame_insert - ensure 'metadata' added consistently in framed and non-framed mode - tests: update tests to ensure metadata is added consistently - fuzzymatch: don't match 204 OPTIONS responses, update fuzzymatcher test * documentation - add documentation for metadata in ui-customization, rebuild docs, - add link to ui customization from configuring - work on access control docs * fixed small typo's in ui-customization.rst * frontendapp: fix doc string - misc: remove warning on urllib3 Retry init - set version to pywb 2.4.0rc0 Co-Authored-By: John Berlin <n0tan3rd@gmail.com> 2019-10-27 01:39:52 +01:00			`pywb\.warcserver\.access\_checker module`
			`----------------------------------------`

			`.. automodule:: pywb.warcserver.access_checker`
			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

			`pywb\.warcserver\.amf module`
			`----------------------------`

			`.. automodule:: pywb.warcserver.amf`
			`: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\.warcserver\.basewarcserver module`
			`---------------------------------------`

			`.. automodule:: pywb.warcserver.basewarcserver`
			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

			`pywb\.warcserver\.handlers module`
			`---------------------------------`

			`.. automodule:: pywb.warcserver.handlers`
			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

			`pywb\.warcserver\.http module`
			`-----------------------------`

			`.. automodule:: pywb.warcserver.http`
			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

			`pywb\.warcserver\.inputrequest module`
			`-------------------------------------`

			`.. automodule:: pywb.warcserver.inputrequest`
			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

			`pywb\.warcserver\.upstreamindexsource module`
			`--------------------------------------------`

			`.. automodule:: pywb.warcserver.upstreamindexsource`
			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

			`pywb\.warcserver\.warcserver module`
			`-----------------------------------`

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


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

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