1
0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-20 02:39:13 +01:00
pywb/docs/index.rst
Ilya Kreymer 31209db311 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

28 lines
716 B
ReStructuredText

.. pywb documentation master file, created by
sphinx-quickstart on Thu Sep 21 01:58:55 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Webrecorder pywb documentation!
================================
Webrecorder (:mod:`pywb`) toolkit is a full-featured, advanced web archiving capture and replay framework for python.
It provides command-line tools and an extensible framework for high-fidelity web archive access and creation.
.. toctree::
:maxdepth: 2
manual/intro
manual/usage
manual/configuring
manual/index
code/pywb
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`