Mostra JavaDocs su GitHub

Sto cercando un modo per convertire i javadocs dal mio progetto open source (generati in Eclipse) per GitHub MarkDown, o venire con qualche altra soluzione semplice per visualizzare la mia documentazione su GitHub (è sufficiente aggiungere semplicemente una directory docs). C'è una soluzione semplice per questo? Posso semplicemente indicare il GitHubREADME.md alla mia directory docs? C'è qualcosa di più elegante? Sono stato colpito da Google.Mostra JavaDocs su GitHub

fonte

2013-03-11 Phil

Immagino che tu possa farlo usando anche il sito Maven. http://stackoverflow.com/questions/3939595/making-javadocs-available-with-github-sonatype-maven-repo potrebbe aiutarti. –

In passato, ho usato [GitHub Pages] (http://pages.github.com/) per pubblicare JavaDocs. E 'stato brutto, ma ha funzionato. –

Non penso sia possibile creare un Javadoc utilizzabile con MarkDown. La soluzione migliore consiste probabilmente nel commit del Javadoc generato nel ramo gh-pages (o nella directory docs/ in base alle impostazioni del progetto). Sarà disponibile all'indirizzo:

http://username.github.io/projectname

Ecco un esempio di uno dei miei progetti:

http://ebourg.github.io/jsign/apidocs/

fonte

2013-03-12 15:03:41

Questo è così vicino ad essere utile, ma non del tutto! La mia documentazione di panoramica è contenuta nei documenti di Asciidoc che contiene riferimenti incrociati alla documentazione dell'API, che viene generata automaticamente dal codice sorgente ed entrambi contengono riferimenti incrociati alle effettive linee di origine. Ma naturalmente l'origine e la documentazione si evolvono nel tempo con la crescita del progetto, quindi la documentazione dell'API deve essere sottoposta a versionamento e vivere sullo stesso ramo dell'origine e di altri documenti. Non c'è modo di farlo con gh-pages, che è il suo ramo separato. –

@JamesElliott probabilmente lo puoi fare con un sottomodulo Git –

@EmmanuelBourg puoi approfondire come funzionerebbe? Quello che ho finito è creare sottodirectory all'interno di gh-pages/api-doc per ogni versione, e usare uno script di shell con sed per aggiornare i riferimenti incrociati di asciidoc alla appropriata gh-pages/api-doc/version quando si taglia il pubblicazione. –

Attualmente è possibile anche ospitare il vostro Javadoc con Github Pagine da non solo un ramo gh-pages, ma direttamente dalla cartella /docs all'interno del ramo master. Puoi consultare la sezione di aiuto su questo argomento, here (controlla anche l'immagine allegata di seguito).

Inoltre, c'è un progetto su Github che gli obiettivi di alcuni conversione del Javadoc to Markdown (non hanno ancora provato, semplicemente lasciando il riferimento).

fonte

2016-10-19 10:23:54 acoelhosantos

Questo, oltre a rsync-ing la mia destinazione di maven/sito/apidocs/directory a docs /, funziona perfettamente per me. Grazie! – awwsmm

Mostra JavaDocs su GitHub

risposta

Problemi correlati