Files
Alex Osborne b3be9d01fe docs: Start a 'Bean Reference' document generated from the source code
This is meant to complement the javadoc by providing a reference
more suitable for users trying to configure crawls rather than
developers writing new modules.

The doc generation could still do with some improving and some of the
source javadoc comments need fixing up but this is already useful so I'm
committing what I have so far.
2021-07-11 15:56:37 +09:00

28 lines
518 B
ReStructuredText

Heritrix 3 Documentation
========================
.. note::
More Heritrix documentation currently lives on the
\ `Github wiki <https://github.com/internetarchive/heritrix3/wiki>`__.
We're in the process of editing some of the structured guides and migrating
them here.
.. toctree::
:maxdepth: 3
:caption: Contents:
getting-started
operating
configuring-jobs
bean-reference
api
glossary
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`