documentation

6calore

1risposta

notazione sinossi della pagina man

Durante la lettura delle pagine man, nella mia esperienza c'è sempre stata una sezione synopsis. per esempio. MV(1) BSD General Commands Manual MV(1) NAME mv -- move files SYNOPSIS mv [

documentation manpage 2013-03-17

---

6calore

2risposta

documentazione Sfinge e autodoc-saltare-membro

Sto costruendo il mio sfinge doc per un progetto Django seguente modo: sphinx-apidoc app -o docs/source/app --force Ora include tutte le migrazioni Sud, che non vogliono avere a la mia documentazion

django documentation python-sphinx 2013-05-08

---

11calore

3risposta

Qual è un buon modo per documentare sub/pub?

Attualmente sto giocando con Backbone/Marionette (anche se la domanda è più generale), e ho un sacco di codice che "invia messaggi" su tutta l'applicazione. Per fare un esempio, qualcosa di simile: ve

javascript backbone.js documentation marionette 2013-04-05

---

13calore

2risposta

Come documentare le eccezioni dei metodi asincroni?

Metodo campione con documentazione XML: // summary and param tags are here when you're not looking. /// <exception cref="ArgumentNullException> /// <paramref name="text" /> is null. /// </exception

c# .net asynchronous documentation 2013-04-09

---

36calore

2risposta

più funzioni in un unico file .rd

Breve versione: Posso emulare la documentazione dei Normal nel pacchetto stats utilizzando roxygen? lungo versione: Sto lavorando su un pacchetto e stava cercando rendere la documentazione più leggibi

r documentation package roxygen roxygen2 2013-04-10

---

6calore

1risposta

Buona letteratura WebGL/letteratura per apprendere i concetti

Recentemente ho iniziato a studiare WebGL, ed è tutto molto eccitante. Voglio davvero essere in grado di codificare le cose da solo, ma sfortunatamente, devo fare molto affidamento su librerie come le

opengl-es documentation opengl-es-2.0 webgl 2013-04-30

---

5calore

3risposta

Come evitare gli avvisi di "SEVERE: Duplicate ID" per i miei moduli autodoc'd in Sfinge?

Sto usando RST/Sfinge per documentare il mio Python, tuttavia quando la costruzione è lanciando avvertimenti come ...Code/doc/code.rst:3: SEVERE: Duplicate ID: "module-toast". file sorgenti mio Pyth

python documentation python-sphinx 2013-05-09

---

17calore

2risposta

Come generare un sito Web dalle pagine wiki di GitHub

Ho usato pagine GitHub per generare un bellissimo sito Web per il mio progetto (this one). Ora voglio mantenere aggiornata la documentazione del mio progetto e avere tutto in un unico file README.md n

github documentation wiki documentation-generation github-pages 2013-05-25

---

16calore

3risposta

Come documentare un'eccezione usando Sfinge

Non riesco a capire come documentare le eccezioni usando Sphinx. ho provato la seguente: def some_funct(): """ :raises: ExceptionType: Some multi-line exception description. """

python exception documentation python-sphinx 2013-04-12

---

5calore

1risposta

L'uso di sé per creare una sitemap con toctree nella sfinge sembra rotto?

Sto aggiornando una FAQ per un progetto abbastanza grande e vorrei aggiungere un indice delle domande nella parte superiore della pagina, in modo che gli utenti possano trovare più facilmente ciò che

documentation python-sphinx 2013-04-21

---