Skip to content

Commit

Permalink
KAFKA-2666: Docs: Automatically generate documentation from config cl…
Browse files Browse the repository at this point in the history
…asses

…the way we always planned to

Author: Gwen Shapira <[email protected]>

Reviewers: Jun Rao, Guozhang Wang

Closes apache#382 from gwenshap/KAFKA-2666
  • Loading branch information
gwenshap committed Nov 7, 2015
1 parent 30bf985 commit b4e1bdf
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 490 deletions.
22 changes: 21 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -301,13 +301,33 @@ project(':core') {
into "$buildDir/dependant-libs-${scalaVersion}"
}

task siteDocsTar(type: Tar) {
tasks.create(name: "genProducerConfigDocs", dependsOn:jar, type: JavaExec) {
classpath = sourceSets.main.runtimeClasspath
main = 'org.apache.kafka.clients.producer.ProducerConfig'
standardOutput = new File('docs/producer_config.html').newOutputStream()
}

tasks.create(name: "genConsumerConfigDocs", dependsOn:jar, type: JavaExec) {
classpath = sourceSets.main.runtimeClasspath
main = 'org.apache.kafka.clients.consumer.ConsumerConfig'
standardOutput = new File('docs/consumer_config.html').newOutputStream()
}

tasks.create(name: "genKafkaConfigDocs", dependsOn:jar, type: JavaExec) {
classpath = sourceSets.main.runtimeClasspath
main = 'kafka.server.KafkaConfig'
standardOutput = new File('docs/kafka_config.html').newOutputStream()
}

task siteDocsTar(dependsOn: ['genProducerConfigDocs', 'genConsumerConfigDocs', 'genKafkaConfigDocs'], type: Tar) {
classifier = 'site-docs'
compression = Compression.GZIP
from project.file("../docs")
into 'site-docs'
}



tasks.create(name: "releaseTarGz", dependsOn: configurations.archives.artifacts, type: Tar) {
into "kafka_${baseScalaVersion}-${version}"
compression = Compression.GZIP
Expand Down
Loading

0 comments on commit b4e1bdf

Please sign in to comment.