Я ищу способ конвертировать Javadocs из моего проекта с открытым исходным кодом (генерируется в Затмении) в GitHub уценки или придумать какое-то другое простым решением для отображения документации на GitHub (застенчивый просто добавить каталог docs). Есть ли простое решение для этого? Могу ли я просто указать GitHubREADME.md в мой каталог docs? Есть ли что-то более элегантное? Я ударил по Google.Показать JavaDocs на GitHub
Я не думаю, что можно сделать полезный Javadoc с MarkDown. Лучшее решение, вероятно, состоит в том, чтобы зафиксировать Javadoc, сгенерированный вами на ветке gh-pages (или в каталоге в зависимости от настроек вашего проекта). Он будет доступен по адресу:
http://username.github.io/projectname
Вот пример одного из моих проектов:
Это так близко к тому, чтобы быть полезным, но не совсем! Моя обзорная документация содержится в документах Asciidoc, которые содержат перекрестные ссылки на документацию API, которая автоматически генерируется из исходного кода, и оба содержат перекрестные ссылки на фактические исходные строки. Но, разумеется, источник и документация развиваются со временем по мере роста проекта, поэтому документация API должна быть версией и жить в той же ветви, что и источник и другие документы. Невозможно сделать это с помощью gh-страниц, который является его собственной отдельной ветвью. –
@JamesElliott, возможно, вы можете сделать это с помощью подмодуля Git –
@ EmmanuelBourg вы можете подробно рассказать о том, как это работает? То, что я закончил, это создание подкаталогов в gh-pages/api-doc для каждой версии и использование сценария оболочки с sed для обновления перекрестных ссылок asciidoc на соответствующие gh-pages/api-doc/version при разрезании выпуск. –
В настоящее время вы также можете разместить Javadoc с Github Страницы из не только филиал gh-pages, но непосредственно из папки /docs в вашей ветке master. Вы можете проверить раздел справки по этой теме, here (также проверьте прикрепленное изображение ниже).
Кроме того, есть проект на Github, который нацелен некоторое преобразование Javadoc to Markdown (не пробовал еще, оставив только ссылку).
Это, плюс rsync-ing my maven target/site/apidocs/directory to docs /, отлично работает для меня. Благодаря! – awwsmm
Я думаю, вы можете сделать это, используя сайт maven. http://stackoverflow.com/questions/3939595/making-javadocs-available-with-github-sonatype-maven-repo может вам помочь. –
В прошлом я использовал [GitHub Pages] (http://pages.github.com/) для публикации JavaDocs. Это было некрасиво, но это сработало. –