Criando documentação com maven

Question

Eu sou apenas no meio de revisitar Maven. Nossa equipe teve uma experiência ruim quando nós última olhou para isso, como foi durante o período em que o perito foi rearquitetar de 1.x para 2.x, então um monte de dependências que precisávamos não tinha sido movido através dos novos repositórios . No entanto, tenho a hora de reconsiderar agora.

Estou interessado em usar maven e quer LaTeX ou DocBook para a criação de documentação, e eu queria saber se alguém teve alguma experiência para compartilhar, projeto de estrutura / módulo, bons plugins para utilização, etc ...

Muito obrigado: -)

Editar:

Só para esclarecer, eu estava olhando para escrever um artigo técnico / livro, e meu artefato desejado provavelmente seria um PDF.

Answer 1

Eu recentemente implementado a documentação do projeto para o meu projeto multi-módulo maven usando docbook eo docbkx plugin para o Maven. Agora tenho que automaticamente gerar html e pdf arquivos cada vez que eu construir o site do projeto. Acho docbkx realmente rochas, então eu sugiro que você usá-lo.

Seu verdadeiro -Você pode criar um local muito agradável apenas usando o site e doxia Maven plugins. Na verdade eu estou usando os dois para gerar o meu site do projeto, mas doxia suporte para docbook é muito limitado e não permite que você modularizar documentação, incluindo partes de documentos em um documento principal, por exemplo. Assim, para os grandes-referência manuais Estou usando docbkx.

Se você quiser dar uma olhada, meu projeto é aqui . Você pode realmente baixar o código fonte e ver o âmago da questão disso. E, claro, se você tiver qualquer pergunta sobre esta configuração, eu serei mais do que feliz em ajudar.

Felicidades Carlos

Answer 2

DocBook é uma das muitas entradas suportados para Doxia, o motor utilizado para gerar docs pelo Maven. Consulte aqui: http://maven.apache.org/doxia/modules/index.html

Na verdade, o site Doxia responde a sua pergunta exata: http: //maven.apache .org / doxia / livro / index.html

Answer 3

Você pode facilmente criar um site (que contém documentação) com Maven usando o comando mvn site (ou seja, usando o plugins local ).

Este plugin cria relatórios técnicos (tais como Javadoc, Unidade de relatórios de testes, cobertura de código ...), mas também pode ser usado para criar um "local real". Você tem mais detalhes sobre isso em esta página .

Basicamente, você escreve sua página usando APT ( Texto Quase Plain , que é bastante simples de entender), ou um formato baseado em XML, xdoc .

2 anos atrás, eu criar um guia de usuário completo para um aplicativo que eu desenvolvi, usando o formato xdoc eo plugin do site Maven. Globalmente, foi muito fácil de criar!

Espero que isso irá ajudá-lo!

Answer 4

Eu tenho usado com sucesso o Maven plug-in Docbkx. Você deve dar-lhe uma tentativa

Docbkx

Answer 5

Você deve definitivamente dar uma olhada na Maven Docbkx Plugin . Ele provavelmente se adapta às suas necessidades. suporte de DocBook do Doxia é suboptimal -uhm-. Na verdade, a última vez que eu tentei, ele gerado algo novo que - tanto quanto eu poderia dizer - não foi DocBook.

O Maven Docbkx Plugin que eu estou me referindo a suportes todas as personalizações do mundo (através de plugins parâmetros, ou substituições XSLT, se você estiver em que) + possui alguns mecanismos para integrá-lo com a construção Maven. (Tais como processamento de instruções para incluindo propriedades pom Maven em seus documentos.)

Note que a ambição é ter um plugin que o impede de ter que colocar manualmente em conjunto uma cadeia de processamento de vós. Portanto, este plugin irá ambos fazem a transformação para FO, e transformando isso para PDF.

Answer 6

Embora a questão é bastante antigo que eu quero dar uma atualização sobre este assunto. Se você quiser usar LaTeX para a documentação que você deve usar um maven plugin para gerar a documentação. Há um par de-plugins Maven fazendo isso, mas muitos deles não são mais mantido. Há um novo maven-plugin que requer nenhum ou menos de configuração para fazê-lo funcionar e o PDF gerado (ou PS ou DVI) podem ser publicados como artefato.

Tenha um olhar em: Mathan-latex-maven-plugin

Answer 7

Há AFAIK nenhum funcionário ou plugin semi-oficial que irá processar LaTeX ou DocBook, mas o que você poderia fazer (além de usar o plugin local acima mencionado) é configurar o plugin exec para processar seus látex / DocBook fontes durante o ciclo de vida local , ou seja, ao mesmo tempo que o site do projeto é construído.

por exemplo., Algo como

<plugin>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>exec-maven-plugin</artifactId>
  <executions>
    <execution>
    <id>latex</id>
    <goals>
      <goal>exec</goal>
    </goals>
    <phase>site</phase>
      <configuration>
          ...
      </configuration>
    </execution>
  </executions>
</plugin>