Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Would be nice to use in the <reporting> section of pom.xml for maven-site #6

Open
PatrickSauts opened this issue Nov 6, 2014 · 4 comments

Comments

@PatrickSauts
Copy link

Right now to be able to deploy the groovydoc with maven site
I have to add this to the pom.xml

   <plugin>
    <artifactId>maven-resources-plugin</artifactId>
    <executions>
     <execution>
      <id>copy-groovydocs-to-site</id>
      <phase>site</phase>
      <goals>
       <goal>copy-resources</goal>
      </goals>
      <configuration>
       <outputDirectory>${project.reporting.outputDirectory}/groovydocs</outputDirectory>
        <overwrite>true</overwrite>
       <resources>
        <resource>
         <directory>${project.build.directory}/groovydoc</directory>
         <includes>
          <include>**/*</include>
         </includes>
        </resource>
       </resources>
      </configuration>
     </execution>
    </executions>
   </plugin>

And that to site.xml

    <menu name="GroovyDocs">
      <item title="GroovyDocs" name="GroovyDocs" href="groovydocs/index.html" />
    </menu>
@rvowles
Copy link
Owner

rvowles commented Nov 6, 2014

I welcome pull requests!

@PatrickSauts
Copy link
Author

ok I'll do my best

@ekkerbj
Copy link

ekkerbj commented Mar 2, 2015

I second this issue, and can test pull requests as well. It would be great to have the generated groovy docs replace the javadocs in the site since it will be a joint java/groovy doc set.

@ksuderman
Copy link

I found this issue while searching for a solution to do the same; include the generated GroovyDocs in the reports section of Maven generated site. While I wish the process were a little easier, I wanted to point out that the resource plugin is not required to copy the generated docs to the site. Simply specify a destination directory for the groovydoc-maven-plugin:

<plugin>
    
    <groupId>com.bluetrainsoftware.maven</groupId>
    
    <artifactId>groovydoc-maven-plugin</artifactId>
    
    <version>1.3</version>
    ...
    <configuration>
        <destinationDirectory>${project.reporting.outputDirectory}/groovydoc</destinationDirectory>

    </configuration>

</plugin>


You will still need to edit the site.xml to include a link to the documentation, but at least it is one less plugin that needs to be configured.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants