[Archive-crawler-cvs] [internetarchive/heritrix3] 89e5ec: docs: replace javalang with an annotation processor

[Alex O. <no...@gi...>]

  Branch: refs/heads/master
  Home:   https://github.com/internetarchive/heritrix3
  Commit: 89e5ecc7d6e878c6cc893503390a2036ea43fbd0
      https://github.com/internetarchive/heritrix3/commit/89e5ecc7d6e878c6cc893503390a2036ea43fbd0
  Author: Alex Osborne <aos...@nl...>
  Date:   2025-10-28 (Tue, 28 Oct 2025)

  Changed paths:
    M .readthedocs.yml
    A docgen/pom.xml
    A docgen/src/main/java/org/archive/crawler/BeanDocProcessor.java
    A docgen/src/main/resources/META-INF/services/javax.annotation.processing.Processor
    M docs/_ext/beandoc.py
    M docs/bean-reference.rst
    M docs/configuring-jobs.rst
    M docs/requirements.txt
    M pom.xml

  Log Message:
  -----------
  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.


  Commit: 03b9c2724787febd7a317ad47dc3c90a875a247e
      https://github.com/internetarchive/heritrix3/commit/03b9c2724787febd7a317ad47dc3c90a875a247e
  Author: Alex Osborne <aos...@nl...>
  Date:   2025-10-28 (Tue, 28 Oct 2025)

  Changed paths:
    M .readthedocs.yml
    A docgen/pom.xml
    A docgen/src/main/java/org/archive/crawler/BeanDocProcessor.java
    A docgen/src/main/resources/META-INF/services/javax.annotation.processing.Processor
    M docs/_ext/beandoc.py
    M docs/bean-reference.rst
    M docs/configuring-jobs.rst
    M docs/requirements.txt
    M pom.xml

  Log Message:
  -----------
  Merge pull request #683 from internetarchive/ato/beandoc

docs: replace javalang with an annotation processor


Compare: https://github.com/internetarchive/heritrix3/compare/ab589e6b18e1...03b9c2724787

To unsubscribe from these emails, change your notification settings at https://github.com/internetarchive/heritrix3/settings/notifications