pydoctor - Online nel cloud

PROGRAMMA:

NOME

pydoctor - generatore di documentazione API per Python

SINOSSI

dottore [Opzioni]

DESCRIZIONE

Pydoctor è un generatore di documentazione API che funziona principalmente con l'analisi statica.

È stato scritto principalmente per sostituire epydoc ai fini del progetto Twisted as
epydoc ha difficoltà con zope.interface, ma può essere usato per codice Python non Zope come
bene.

VERSIONI

-h, --Aiuto
mostra questo messaggio di aiuto ed esci

-c CONFIGURA, --config=FILE DI CONFIGURAZIONE
Usa config da questo file (qualsiasi opzione della riga di comando sovrascrive le impostazioni da
file).

-p INGRESSO SOTTACETO, --input pickle=INGRESSO SOTTACETO
Carica il sistema da questo file pickle (impostazione predefinita: nessuno, viene creato un sistema vuoto).

-o USCITA, --output-pick=OUTPICKLE
Salva il sistema in questo file pickle (predefinito: nessuno, il sistema non viene salvato da
predefinito).

--sistema extra=SYS:URL PREFISSO
Cerca oggetti in questo sistema per. I collegamenti a questi oggetti avranno URLPREFIX
anteposto a loro.

--classe di sistema=CLASSE DI SISTEMA
Un nome puntato della classe da utilizzare per creare un sistema.

--Nome del progetto=NOME DEL PROGETTO
Il nome del progetto, appare nell'html.

--url-progetto=PROGETTOURL
L'URL del progetto, se fornito, appare nell'html.

--dir-base-progetto=DIRECTORY PROJECTBASE
Percorso assoluto alla directory di base del progetto. I collegamenti alla fonte verranno calcolati
in base a questo valore.

--test
Non lamentarti se la corsa non ha alcun effetto.

--pdb Come py.test's --pdb.

--make-html
Produrre output html.

--server
Servi HTML su un server locale.

--porta del server=SERVER_PORT
Il porto per --server usare.

--solo-locale
Associa il server solo a localhost.

--rivolto-percorso=FRONTE_PERCORSO
Configura un VHostMonster, con tutta la confusione che implica.

--modificare Quando servi HTML, consenti la modifica.

--nessun controllo
Quando offri HTML e consenti la modifica, non controllare prima tutte le docstring.

--aggiungi-pacchetto=PACCHETTO DIR
Aggiungi un pacchetto al sistema. Può essere ripetuto per aggiungere più di un pacchetto.

--aggiungi-modulo=MODULO
Aggiungi un modulo al sistema. Può essere ripetuto.

--prepend-pacchetto=PACCHETTO PREPENDUTO
Fai finta che tutti i pacchetti siano all'interno di questo. Può essere utilizzato per documentare parte di a
pacchetto.

--resolve-alias
Questo aggiorna i riferimenti alle classi importate da un modulo in cui erano
importati in riferimenti a dove sono definiti.

--abbreviare-specialcase=ABBREVAPPING
Questo è un elenco separato da virgole di coppie chiave=valore. Dove qualsiasi chiave corrisponde a a
nome e valore del modulo è l'abbreviazione desiderata. Questo può essere usato per risolvere
è in conflitto con l'abbreviazione in cui hai due o più moduli che iniziano con il
stessa lettera. Esempio: twistedcaldav=tcd.

--docformat=DOCFORMATO
In quale formato supportato da epydoc si presume che siano presenti le docstring.

--oggetto-html=OGGETTI HTML
Il nome completo dell'oggetto per cui generare i documenti API (impostazione predefinita: tutto).

--html-pagine-riepilogo
Genera solo le pagine di riepilogo.

--pagine-funzione-di-scrittura-html
Crea file HTML individuali per ogni funzione e metodo. Non sono collegati a in
qualsiasi HTML generato da pydoctor, ma possono essere utili per il collegamento di terze parti.

--output-html=USCITA HTML
Directory in cui salvare i file HTML (predefinito 'apidocs')

--html-scrittore=SCRITTORE HTML
Nome con punti della classe di scrittura HTML da utilizzare (predefinito 'pydoctor.nevowhtml.NevowWriter',
richiede l'installazione di Divmod Nevow).

--html-viewsource-base=BASE FONTI HTML
Questo dovrebbe essere il percorso del browser trac per la parte superiore del checkout svn che siamo
documentare parte di.

--html-usa-ordinabile
Usa la libreria JS ordinabile per creare tabelle di contenuti di pacchetti, moduli e classi
ordinabile

--html-use-splitlink
Genera JavaScript (non invadente) per consentire la visualizzazione dei metodi di classe in uno
tavolo per classe base o in un unico grande tavolo.

--html-accorcia-liste
Genera JavaScript (non invadente) per nascondere alcune delle voci in lunghi elenchi di
ad es. sottoclassi.

--livecheck
Importa ed esamina anche i moduli. XXX non funziona in questo momento

-v, --verboso
Sii più rumoroso. Può essere ripetuto per più rumore.

-q, --silenzioso
Stai più tranquillo.

--auto Modalità Automagic: analizza tutti i moduli e i pacchetti nella directory di lavoro corrente
ed eseguire un server locale che consente l'esame e la modifica delle docstring.

--verboso-su=palcoscenico
Sii più rumoroso durante una particolare fase della generazione.

Usa pydoctor online utilizzando i servizi onworks.net