1
0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-15 08:04:49 +01:00
pywb/docs/code/pywb.utils.rst
Ilya Kreymer 6f79840b79
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

87 lines
1.5 KiB
ReStructuredText

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\.merge module
-------------------------
.. automodule:: pywb.utils.merge
: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: