Commit Graph

6 Commits

Author SHA1 Message Date
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
Alex Osborne 6fb699c780 docs: s/Most/More/ documentation lives on the wiki
A large amount of core documentation has now been migrated here. There's
still a lot to go but I don't think 'most' applies anymore.
2021-07-10 12:42:17 +09:00
Alex Osborne a84e0bb792 docs: Add an operating guide based on the contents of the wiki 2021-07-07 21:30:36 +09:00
Alex Osborne 507d7d91a3 docs: add getting-started.rst, configuring-jobs.rst and glossary.rst
Compiled from the wiki with some restructuring, reformatting and
updating for the current version of Heritrix.
2021-07-06 22:44:11 +09:00
Alex Osborne 1ff31c135e Add explanatory note about documentation 2018-07-04 19:48:33 +09:00
Alex Osborne 90db2e33d5 Add skeleton sphinx docs for readthedocs 2018-07-04 16:40:51 +09:00