Per il mio framework JavaScript, vorrei utilizzare Sphinx. Dato che sono nuovo nel mondo della Sfinge, vorrei che le persone mi aiutassero a iniziare con Sphinx e JavaScript.Flusso di lavoro con documentazione su sfinge e JavaScript
Qualsiasi aiuto apprezzato.
migliori saluti
credo che stai cercando Sfinge' JavaScript Domain funzione.
Modifica: Da una rapida occhiata agli strumenti di documentazione &, non sembra che sia possibile utilizzare ReST all'interno del codice JavaScript. Dovrai o scaricare la documentazione dai commenti, o tenerla in giro nei file collaterali.
dispiace per la risposta troppo tardi)
Come te voglio costruire documentazione per il mio quadro JS sulla base di AngularJS.
E oliverseal come, io sto costruito estensione sfinge in modo nativo per sfinge e ext.autodoc sphinxcontrib-autoanysrc
E 'semplice e pulito, ma ha caratteristiche ext.autodoc per le firme di generazione di auto e di altri, ma è abbastanza per me conservare resto documentazione di API quadro in file js)
È possibile implementare funzionalità ext.autodoc con estensione sphinxcontrib-autoanysrc controllare autoanysrc.JSAnalyzer
ho visto questa funzione di dominio, ma non sapete come faccio a iniziare con quella. –
Va bene, non voglio usare ReST all'interno della mia libreria JavaScript, sarebbe bello se tutti i membri della libreria venissero rilevati automaticamente insieme ai commenti associati dalla sfinge. –
Non seguo abbastanza; »Rileva automaticamente i membri della libreria e i commenti associati di sfinge«? AFAIK, Sphinx non sa come leggere il codice JavaScript, quindi non può né analizzare le funzioni o la documentazione associata per te. Ecco perché ho suggerito l'uso di file sidecar. –