Skip to content

Commit

Permalink
add new UI docs:
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
ikreymer committed Dec 14, 2021
1 parent d83c92e commit a85ff06
Show file tree
Hide file tree
Showing 20 changed files with 880 additions and 479 deletions.
91 changes: 45 additions & 46 deletions docs/code/pywb.apps.rst
Original file line number Diff line number Diff line change
@@ -1,78 +1,77 @@
pywb\.apps package
==================
pywb.apps package
=================

Submodules
----------

pywb\.apps\.cli module
----------------------
pywb.apps.cli module
--------------------

.. automodule:: pywb.apps.cli
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.apps\.frontendapp module
------------------------------
pywb.apps.frontendapp module
----------------------------

.. automodule:: pywb.apps.frontendapp
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.apps\.live module
-----------------------
pywb.apps.live module
---------------------

.. automodule:: pywb.apps.live
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.apps\.rewriterapp module
------------------------------
pywb.apps.rewriterapp module
----------------------------

.. automodule:: pywb.apps.rewriterapp
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.apps\.static\_handler module
----------------------------------
pywb.apps.static\_handler module
--------------------------------

.. automodule:: pywb.apps.static_handler
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.apps\.warcserverapp module
--------------------------------
pywb.apps.warcserverapp module
------------------------------

.. automodule:: pywb.apps.warcserverapp
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.apps\.wayback module
--------------------------
pywb.apps.wayback module
------------------------

.. automodule:: pywb.apps.wayback
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.apps\.wbrequestresponse module
------------------------------------
pywb.apps.wbrequestresponse module
----------------------------------

.. automodule:: pywb.apps.wbrequestresponse
:members:
:undoc-members:
:show-inheritance:

:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: pywb.apps
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
31 changes: 15 additions & 16 deletions docs/code/pywb.indexer.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,29 @@
pywb\.indexer package
=====================
pywb.indexer package
====================

Submodules
----------

pywb\.indexer\.archiveindexer module
------------------------------------
pywb.indexer.archiveindexer module
----------------------------------

.. automodule:: pywb.indexer.archiveindexer
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.indexer\.cdxindexer module
--------------------------------
pywb.indexer.cdxindexer module
------------------------------

.. automodule:: pywb.indexer.cdxindexer
:members:
:undoc-members:
:show-inheritance:

:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: pywb.indexer
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
59 changes: 33 additions & 26 deletions docs/code/pywb.manager.rst
Original file line number Diff line number Diff line change
@@ -1,46 +1,53 @@
pywb\.manager package
=====================
pywb.manager package
====================

Submodules
----------

pywb\.manager\.aclmanager module
--------------------------------
pywb.manager.aclmanager module
------------------------------

.. automodule:: pywb.manager.aclmanager
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.manager\.autoindex module
-------------------------------
pywb.manager.autoindex module
-----------------------------

.. automodule:: pywb.manager.autoindex
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.manager\.manager module
-----------------------------
pywb.manager.locmanager module
------------------------------

.. automodule:: pywb.manager.locmanager
:members:
:undoc-members:
:show-inheritance:

pywb.manager.manager module
---------------------------

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

pywb\.manager\.migrate module
-----------------------------
pywb.manager.migrate module
---------------------------

.. automodule:: pywb.manager.migrate
:members:
:undoc-members:
:show-inheritance:

:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: pywb.manager
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
51 changes: 25 additions & 26 deletions docs/code/pywb.recorder.rst
Original file line number Diff line number Diff line change
@@ -1,46 +1,45 @@
pywb\.recorder package
======================
pywb.recorder package
=====================

Submodules
----------

pywb\.recorder\.filters module
------------------------------
pywb.recorder.filters module
----------------------------

.. automodule:: pywb.recorder.filters
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.recorder\.multifilewarcwriter module
------------------------------------------
pywb.recorder.multifilewarcwriter module
----------------------------------------

.. automodule:: pywb.recorder.multifilewarcwriter
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.recorder\.recorderapp module
----------------------------------
pywb.recorder.recorderapp module
--------------------------------

.. automodule:: pywb.recorder.recorderapp
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

pywb\.recorder\.redisindexer module
-----------------------------------
pywb.recorder.redisindexer module
---------------------------------

.. automodule:: pywb.recorder.redisindexer
:members:
:undoc-members:
:show-inheritance:

:members:
:undoc-members:
:show-inheritance:

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

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

0 comments on commit a85ff06

Please sign in to comment.