You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by youhaodeyi <yo...@gmail.com> on 2008/04/10 03:04:54 UTC
Where do I put document in Maven project?
This link lists all the Maven directories:
http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html
but I didn't find a place to hole project document.
--
View this message in context: http://www.nabble.com/Where-do-I-put-document-in-Maven-project--tp16599702s177p16599702.html
Sent from the Maven - Users mailing list archive at Nabble.com.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Where do I put document in Maven project?
Posted by youhaodeyi <yo...@gmail.com>.
Thanks.
Maria Odea Ching-5 wrote:
>
> You can put your project documentation in src/site and it would get
> included
> when you generate the site for your project.
> Please note that your documents should be written in APT format and when
> you
> run 'mvn site', their corresponding html files
> will automatically be generated. Other project documentations such as
> javadocs, project info reports, etc. will also be generated.
>
> Please take a look at the following links for more details:
>
> http://maven.apache.org/guides/mini/guide-site.html
> http://maven.apache.org/doxia/references/apt-format.html
>
> Thanks,
> Deng
>
> On Thu, Apr 10, 2008 at 9:04 AM, youhaodeyi <yo...@gmail.com> wrote:
>
>>
>> This link lists all the Maven directories:
>>
>>
>> http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html
>>
>> but I didn't find a place to hole project document.
>> --
>> View this message in context:
>> http://www.nabble.com/Where-do-I-put-document-in-Maven-project--tp16599702s177p16599702.html
>> Sent from the Maven - Users mailing list archive at Nabble.com.
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
>> For additional commands, e-mail: users-help@maven.apache.org
>>
>>
>
>
--
View this message in context: http://www.nabble.com/Where-do-I-put-document-in-Maven-project--tp16599702s177p16603546.html
Sent from the Maven - Users mailing list archive at Nabble.com.
---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org
Re: Where do I put document in Maven project?
Posted by Maria Odea Ching <oc...@apache.org>.
You can put your project documentation in src/site and it would get included
when you generate the site for your project.
Please note that your documents should be written in APT format and when you
run 'mvn site', their corresponding html files
will automatically be generated. Other project documentations such as
javadocs, project info reports, etc. will also be generated.
Please take a look at the following links for more details:
http://maven.apache.org/guides/mini/guide-site.html
http://maven.apache.org/doxia/references/apt-format.html
Thanks,
Deng
On Thu, Apr 10, 2008 at 9:04 AM, youhaodeyi <yo...@gmail.com> wrote:
>
> This link lists all the Maven directories:
>
>
> http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html
>
> but I didn't find a place to hole project document.
> --
> View this message in context:
> http://www.nabble.com/Where-do-I-put-document-in-Maven-project--tp16599702s177p16599702.html
> Sent from the Maven - Users mailing list archive at Nabble.com.
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
>
>