[Docs] Documentazione ReST-based

Manlio Perillo manlio_perillo a libero.it
Mer 1 Ago 2007 12:22:07 CEST


Daniele Varrazzo ha scritto:
> Ciao,
> 
> dove si trovano info su questa fantomatica documentazione ReST-based di cui
> sto sentendo parlare in questi giorni?
> 

http://pydoc.gbrandl.de:3000/

C'č anche una versione aggiornata del Documenting Python.

I sorgenti invece si trovano nel repository ufficiale di python.

Come si vede, le novitą sono il supporto per "Suggest changes" e "Report 
bug", oltre alla funzionalitą di ricerca (il tutto ancora da implementare).

Infine c'č il supporto per "Visualizza sorgenti".

sphinx č ancora immaturo.
Alan Franzoni soggerisce di usarlo anche per gestire le traduzioni, ma 
richiederebbe comunque uno sforzo non indifferente per ampliare il codice.

Nota: spinx ha un server web integrato, tramite wsgiref (ossia, al 
momento credo che quel sito che ho indicato sia servito dal server 
giocattolo della libreria standard)...



> Per me prima ci si sbarazza di quella basata su LaTeX e meglio č, per cui
> non vedo l'ora che *a python.org* facciano il pasasaggio. 

Si, č senz'altro una buona cosa.

> Per quanto
> riguarda noi, penso che sia meglio non cambiare formato facendo una
> traduzione, quindi direi ReST per i PEP e LaTeX per i docs. O sbaglio?
> 

Dici bene.
Anche le FAQ sono in reST.

Conviene cambiare formato per la documentazione standard per Python 2.6, 
magari con qualcuno di noi che collabori allo sviluppo di sphinx e 
aggiunga funzionalitą per dare supporto anche alle traduzioni.



Saluti  Manlio Perillo


Maggiori informazioni sulla lista Docs