2010-05-26 1 views
2

Maven 플러그인 프로젝트에서 표준 설명서 웹 사이트 (예 : this one)를 생성 할 수있는 것으로 보입니다. 플러그인 프로젝트에서 mvn site을 실행하려고 시도했지만 예상되는 문서 (모조 목표, 매개 변수 등을 보여주는 페이지)가 생성되지 않습니다. 이러한 웹 페이지를 생성하기 위해 호출되어야하는 다른 목표가 있습니까? Maven v. 2.1.0을 사용하고 있습니다.Maven 플러그인 사이트에 대한 문서에 목표 및 매개 변수를 포함하는 방법

+1

* 필요한 문서 *가 무엇을 의미합니까? 예상되는 것은 무엇입니까? 실제 결과는 무엇입니까? –

답변

2

사이트의 문서에 포함, 당신은 이것은 "프로젝트 보고서"를 추가

<project> 
    ... 
    <reporting> 
    <plugins> 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-plugin-plugin</artifactId> 
     <version>2.5.1</version> 
     </plugin> 
    </plugins> 
    </reporting>  
    ... 
</project> 

pom.xml 파일에 다음을 추가해야 Maven 플러그인의 Javadoc에 해당하는 사이트 메뉴에 대한 링크.

+0

감사합니다. 최소한이 사이트의 '프로젝트 보고서'섹션에 '플러그인 문서'페이지가 추가됩니다. '개요'섹션에서 별도의 '목표'및 '사용'페이지로 생성 된이 정보를 자동으로 얻는 방법이 있습니까 ?? (예 : [this] (http://maven.apache.org/plugins/maven-site-plugin/)) – joelittlejohn

+1

해결되었습니다. 나는 [이 가이드] (http://www.vineetmanohar.com/2009/04/how-to-auto-generate-maven-plugin-documentation/)를 따라 목표 링크를 만들었다. •이 작업을 수행 할 수 없다고 생각한다. 자동으로 – joelittlejohn

0

아무 것도 생성되지 않습니까? 이상하게 들리 겠지만 최소한 일반 정보와 종속성에 대한 문서를 포함하는 매우 기본적인 사이트를 구축해야합니다. maven site이 올바른 호출입니다.

추가 문서 (javadoc, 테스트 보고서 등)를 보려면 빌드 파일에 요소를 추가해야합니다. 몇 가지 예를 보려면 surefire 플러그인 설명서를 살펴보십시오.

0

아니요. 프로젝트에는 here과 같은 특정 구조가 있어야합니다. 박스 아웃

2

mvn site 적어도 인덱스 페이지를 생성 (그리고 name 및 프로젝트의 POM에서 description 활용) 및 대한 보고서의 기본 세트 (이슈 트래킹, 프로젝트 팀, 종속성, 프로젝트를해야한다 플러그인, 지속적인 통합, 소스 저장소, 프로젝트 라이센스, 메일 링리스트, 플러그인 관리, 프로젝트 요약).

<project> 
    ... 
    <reporting> 
    <plugins> 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-project-info-reports-plugin</artifactId> 
     <version>2.2</version> 
     <reportSets> 
      <reportSet> 
      <reports> 
       <report>dependencies</report> 
       <report>project-team</report> 
       <report>mailing-list</report> 
       <report>cim</report> 
       <report>issue-tracking</report> 
       <report>license</report> 
       <report>scm</report> 
      </reports> 
      </reportSet> 
     </reportSets> 
     </plugin> 
     ... 
    </plugins> 
    </reporting> 
    ... 
</project> 

당신이 사이트를 사용자 정의하려면

, 당신이 '당신이 보고서의 설정을 사용자 정의하려면합니다 ( reporting 섹션)에 Maven Project Info Reports Plugin 원하는 보고서 만 포함하도록 구성 할 수 있습니다

site descriptor (기본값 : src/site/site.xml)을 제공해야합니다. 이 경우 위의 보고서에 <menu ref="reports"/> 항목을 포함시켜야합니다.

add content을 원할 경우 지원되는 형식 (예 : APT, FML, XDoc) 중 하나를 사용하여 제공해야합니다. 대부분의 시간은 APT입니다.

자세한 내용은 Maven Site Plugin의 설명서를 확인하십시오. (등 목표, PARAMS) 플러그인 설명서를 얻기 위하여

관련 문제