Vorrei includere informazioni sulle attività di Rake nella nostra app Rails. Utilizziamo la documentazione YARD per la documentazione e al momento le pagine come lib/tasks/development.rake vengono visualizzate come testo non formattato.Come documentare le attività di Rake con YARD?
Posso renderli visualizzati come codice sorgente Ruby utilizzando # @markup rubyfrom the YARD documentation.
Tuttavia, questo rende solo i commenti in linea, anche se includono le direttive YARD come # @!method foo. Questo significa che the YARD documentation on tagging DSLs non sembra essere applicabile.
Mi manca qualcosa?
Come posso ottenere YARD per riconoscere il codice e la documentazione nei file .rake?
N.B. Sarei felice con una soluzione che ignori il codice effettivo e generi solo la copia della documentazione, ma la fonte per la copia della documentazione deve essere il file .rake stesso - Non voglio che la documentazione viva in un file separato .markdown (o qualsiasi altra cosa) dato che c'è troppe possibilità che vada fuori sincrono.
Maggiori informazioni - il comando yard:
Sto usando un file .yardopts contenente quanto segue:
--asset graphs 'app/**/*.rb' 'lib/**/*.rb' - README info/*
Per arrivare YARD di leggere i compiti Rake posso aggiungere 'lib/tasks/*.rake'dopo la trattino (ad esempio aggiungi i file di Rake all'elenco YARD "Files"), ma come indicato sopra non li elabora correttamente.
Come da suggerimento di Benjamin sotto, ho provato ad aggiungere 'lib/tasks/*.rake'prima il trattino (cioè aggiungere file Rake alla lista dei file regolari di Ruby da lavorare), ma questo non sembra generare nulla.
E 'possibile che YARD stia generando qualcosa ma non nella posizione prevista/con il nome file atteso, suppongo, non sono abbastanza familiare con il modo in cui YARD lavora per capire se c'è un output orfano da qualche parte. Non c'è certamente niente di appropriato nella ricerca che YARD genera, e un semplice find doc | grep rake o find doc | grep basename_of_rake_file non mostra nulla.
Si tratta semplicemente di far sì che Yard riconosca i file '* .rake' come rubini? – ipd
Temo di non averlo guardato molto da quando ho chiesto, ma suppongo che lo sia, sì. Tuttavia, in realtà _specifying_ che sono Ruby con la direttiva '# @markup ruby' non funziona perché rende solo il Ruby, cioè non elabora i commenti della documentazione – Leo
@Leo, specifica l'estensione del rake nella guida della riga di comando? _yardoc * .rake -o out/_? – benjamin