asciidoctor / asciidoclet

:clipboard: A Javadoc Doclet based on Asciidoctor that lets you write Javadoc in the AsciiDoc syntax.
https://github.com/asciidoctor/asciidoclet
Apache License 2.0
133 stars 40 forks source link

Q: How to configure asciidoclet to use asciidoctorj and asciidoctorj-diagram in pom.xml #63

Closed MehrCurry closed 5 years ago

MehrCurry commented 7 years ago

I have asciidoctorj and asciidoctorj-diagram in my pom.xml to generate maven site documentation. How do i configure asciidoclet to use these versions, too?

johncarl81 commented 6 years ago

This should be a configuration of the maven javadoc plugin. Maybe additionalDependencies?

dakusui commented 5 years ago

After installing asciidoctor-diagram, following pom.xml fragment worked for me. Embedding diagrams in Javadoc will be useful for you.

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <asciidoclet.version>1.5.4</asciidoclet.version>
    <env.GEM_PATH>/var/lib/gems/2.5.0</env.GEM_PATH>
  </properties>
  ...
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-javadoc-plugin</artifactId>
          <version>2.9</version>
          <executions>
            <execution>
              <id>attach-javadocs</id>
              <goals>
                <goal>jar</goal>
              </goals>
            </execution>
          </executions>
          <configuration>
            <doclet>org.asciidoctor.Asciidoclet</doclet>
            <docletArtifact>
              <groupId>org.asciidoctor</groupId>
              <artifactId>asciidoclet</artifactId>
              <version>${asciidoclet.version}</version>
            </docletArtifact>
            <additionalJOptions>
              <additionalJOption>--require asciidoctor-diagram</additionalJOption>
              <additionalJOption>--gem-path ${env.GEM_PATH}</additionalJOption>
              <additionalJOption>--attribute data-uri</additionalJOption>
            </additionalJOptions>
          </configuration>
        </plugin>