Mostrar JavaDocs en GitHub
Estoy buscando una manera de convertir el javadocs de mi proyecto de código abierto (generado en Eclipse) a GitHub Rebajas, o con alguna otra solución simple para mostrar mi documentación en GitHub (tímido, simplemente agregando un docs directorio). Hay una solución simple para esto? ¿Puedo simplemente señalar el GitHub README.md ¿a mi directorio docs? Hay algo más elegante? He estado ponchando en Google .
2 answers
No creo que sea posible hacer un Javadoc utilizable con MarkDown. La mejor solución es probablemente confirmar el Javadoc que generaste en la rama gh-pages (o en el directorio docs/ dependiendo de la configuración de tu proyecto). Estará disponible en :
Http://username.github.io/projectname
He Aquí un ejemplo de uno de mis proyectos:
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-01-18 16:17:48
Actualmente también puedes alojar tu Javadoc con Github Pages no solo desde una rama gh-pages, sino directamente desde la carpeta /docs dentro de tu rama master. Puede consultar la sección de ayuda sobre este tema, aquí (también consulte la imagen adjunta a continuación).
Además, hay un proyecto en Github que apunta a alguna conversión de Javadoc a Markdown (no lo he probado todavía, solo dejando la referencia).
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2016-10-19 10:23:54