documentation-generation

5calore

1risposta

Perché ocamldoc ha esito negativo sui moduli non associati?

Qui è un'interfaccia ad esempio test.mli, ha commentato con i commenti ocamldoc-style: (** ocamldoc module comment *) open MissingModule;; (** ocamldoc function comment *) val test : unit;; Se fa

23calore

4risposta

come generare documentazione api

Ho bisogno di scrivere una documentazione api per un'API REST che ho creato. Ci sono strumenti che cancellano un output html simile nello stile alla documentazione di underscore api? O forse qualcosa

8calore

3risposta

Utilizzando Appledocs per generare la documentazione

Mi scuso per la semplicità della mia domanda, ma stavo cercando di generare la documentazione utilizzando Appledocs (https://github.com/tomaz/appledoc#quick-install) io non sono sicuro di come esattam

26calore

2risposta

Swagger With Static Documentazione

Sto cercando di usare Swagger per documentare la mia interfaccia riposante. Il problema è che non voglio generare automaticamente la mia documentazione annotando il mio codice. Fondamentalmente non vo

5calore

1risposta

Conversione di phpdoc in docset utilizzabile da Dash

Sto cercando di ottenere lo Magento Documentation in un formato che possa essere utilizzato in Dash. Un article sul sito web di Dash descrive come importare un certo numero di tipi di documentazione n

5calore

2risposta

Fare riferimento a un metodo di classe specifico con il comando @see utilizzando Doxygen

Non è stato possibile fare riferimento a un metodo di classe specifico utilizzando il comando doxygen @see. Supponiamo che io sono una classe di server con un metodo start come qui di seguito @interfa

8calore

1risposta

Documentazione di classi e moduli in YUIDocs

Ho un po 'di problemi a scrivere la mia documentazione per un insieme di moduli raggruppati. Penso che sia in parte un equivoco su cosa rappresentano @class, @module e @namespace. (O forse è il risult

5calore

1risposta

Trasforma il codice sorgente in LaTeX

Mi capita spesso di trovare molte equazioni fisiche implementate in Java e Fortran. Nella maggior parte dei casi queste equazioni sono copiate direttamente da un manuale di fisica avanzata o da una pu

16calore

5risposta

Come impedire a GitHub Pages "Automatic Generator" di rimuovere tutto prima di rigenerare il sito?

Ho creato un meraviglioso GitHub Pages website for my little project e ho aggiunto altre pagine nel ramo gh-pages. Il mio problema è che, ogni volta che rigenera il sito Web da "Impostazioni => Genera

14calore

2risposta

Come documentare i parametri della funzione Python con sphinx-apidoc

Sto cercando di pulire la mia documentazione del codice Python e ho deciso di usare sphinx-doc perché sembra buono. Mi piace come posso fare riferimento altre classi e metodi con tag come: :class:`mym