pywb/docs/code/pywb.rst

pywb package
============

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

.. toctree::

    pywb.apps
    pywb.indexer
    pywb.manager
    pywb.recorder
    pywb.rewrite
    pywb.utils
    pywb.warcserver

Submodules
----------

pywb\.version module
--------------------

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


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

.. automodule:: pywb
    :members:
    :undoc-members:
    :show-inheritance:
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`pywb package`
			`============`

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

			`.. toctree::`

			`pywb.apps`
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.indexer`
			`pywb.manager`
			`pywb.recorder`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`pywb.rewrite`
			`pywb.utils`
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`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
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			`Submodules`
			`----------`

			`pywb\.version module`
			`--------------------`

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


add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00			`Module contents`
			`---------------`

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