backup/pywb
1
0
Fork 0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-15 08:04:49 +01:00
Code Issues Projects Releases Activity
pywb/docs/code/pywb.apps.rst

78 lines
1.3 KiB
ReStructuredText
Raw Permalink Normal View History

docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
pywb.apps package
=================
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
Submodules
----------
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
pywb.apps.cli module
--------------------
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.apps.cli
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08: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
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
pywb.apps.frontendapp module
----------------------------
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.apps.frontendapp
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08: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
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
pywb.apps.live module
---------------------
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.apps.live
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08: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
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
pywb.apps.rewriterapp module
----------------------------
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.apps.rewriterapp
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08: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
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
pywb.apps.static\_handler module
--------------------------------
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.apps.static_handler
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08: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
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
pywb.apps.warcserverapp module
------------------------------
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.apps.warcserverapp
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08: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
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
pywb.apps.wayback module
------------------------
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.apps.wayback
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08: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
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
pywb.apps.wbrequestresponse module
----------------------------------
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.apps.wbrequestresponse
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08: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
Module contents
---------------
.. automodule:: pywb.apps
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs
2021-12-13 22:54:29 -08:00
:members:
:undoc-members:
:show-inheritance:
Reference in New Issue Copy Permalink