7 Commits

Author SHA1 Message Date
Alex Osborne 3718480cd5 docs: Add Groovy versions of config examples
Uses sphinx-inline-tabs to render tabs offering the choice between XML and Groovy syntax for each example.
2026-05-03 12:07:01 +09:00
Alex Osborne 89e5ecc7d6 docs: replace javalang with an annotation processor
This means we can rely on the Java compiler to parse the source code instead of the old python library which no longer works as it only supported Java 8 source code. The new processor generates a META-INF/heritrix-beans.json file for each module at compile time which the sphinx beandoc plugin then reads.

My intent is to eventually use the heritrix-beans.json files to also implement autocomplete and context-sensitive help in the Heritrix config editor.
2025-10-28 16:26:19 +09:00
Alex Osborne 81ac46be45 docs: Catch parse errors and continue generating
Looks like the javalang parser doesn't handle some newer syntax.
For now just catch the errors. Long term we probably need to switch
to a different parser.
2025-05-13 14:09:09 +09:00
Alex Osborne 2a027a4064 docs: Fallback to field javadoc comments when setter javadoc unavailable
This enables us to generate documentation for more bean properties,
although a number of beans have javadoc on initializer code blocks which
makes it hard to access. This affects javadoc and IDE contextual
documentation too so should probably be fixed in the source code itself.
2021-07-12 19:31:13 +09:00
Alex Osborne 4dfe48b1a0 docs: Strip @link and @code javadoc directives from bean reference 2021-07-12 09:28:04 +09:00
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 c2c2b244de docs: Add a plugin for basic auto-generation of bean examples 2021-07-10 21:09:17 +09:00