代码之家  ›  专栏  ›  技术社区  ›  StaxMan

使JavaDocs与GitHub、Sonatype Maven repo一起可用[关闭]

  •  23
  • StaxMan  · 技术社区  · 15 年前

    尽管Github为Java开源项目提供了一个很好的归宿,但与更成熟的开源托管场所相比,仍然缺少一些东西。到目前为止,我已经发现Sonatype为开放源码项目提供了Maven存储库访问,这解决了一个问题;还有许多用户/开发人员邮件列表的解决方案。

    但我现在试图解决的一件事是发布自动生成的用于在线浏览的javadocs。虽然通过Maven发布源jar对ide有点帮助,但我仍然喜欢在不下载或导入项目的情况下在线浏览javadocs。有谁知道在Github托管的项目中实现这一点的好方法吗?(不必是Github提供的东西,但理想情况下,当版本被剪切时,可以自动执行的东西)

    4 回复  |  直到 15 年前
        1
  •  26
  •   Jake Wharton    15 年前

    gh-pages 你的回购分行 http://your_username.github.com/your_repo/

    1. 发布 pom.xml .
    2. 将JavaDocs生成到 .gitignore
    3. 签出 gh页
    4. 用JavaDocs复制到的目录替换工作目录中的所有文件
    5. 提交
    6. 签出原始分支。
    7. 继续释放。。。

    我只花了两天时间在我的一些项目中使用Maven,所以这远远超出了我的能力。我很想看到这是用现有的插件或自定义插件实现的。

        2
  •  16
  •   Gewthen    13 年前

    现在有一个Maven插件可以将目录推送到githib上的特定分支: http://github.com/github/maven-plugins .

        3
  •  1
  •   John Kristian    14 年前
        4
  •  0
  •   Samuel Santos    11 年前

    您可以使用github页面,创建一个静态web站点,然后将javadoc放在一个目录中,并将commmit发送到gh pages分支。

    看见

    http://readwrite.com/2013/11/27/github-pages-explained#awesm=~oII5EQELsqV6S7

    推荐文章