pydoctor - En ligne dans le Cloud

PROGRAMME:

Nom

pydoctor - générateur de documentation API pour Python

SYNOPSIS

pédicure [Options]

DESCRIPTION

Pydoctor est un générateur de documentation API qui fonctionne principalement par analyse statique.

Il a été écrit principalement pour remplacer epydoc dans le cadre du projet Twisted en tant que
epydoc a des difficultés avec zope.interface, mais peut être utilisé pour du code Python non Zope comme
Hé bien.

OPTIONS

-h, --Aidez-moi
afficher ce message d'aide et quitter

-c FICHIERCONFIG, --config=FICHIER DE CONFIGURATION
Utilisez la configuration de ce fichier (toutes les options de la ligne de commande remplacent les paramètres du
fichier).

-p ENTRÉE PIQUÉ, --entrée-cornichon=PICKLE D'ENTRÉE
Chargez le système à partir de ce fichier pickle (par défaut : aucun, un système vierge est créé).

-o SORTIE PICKLE, --sortie-cornichon=SORTIE PICKLE
Enregistrez le système dans ce fichier pickle (par défaut : aucun, le système n'est pas enregistré par
défaut).

--système supplémentaire=SYS:PREFIXURL
Recherchez des objets dans ce système pour. Les liens vers ces objets auront URLPREFIX
leur a été ajouté.

--classe-système=SYSTÈME CLASSE
Un nom en pointillé de la classe à utiliser pour créer un système.

--nom du projet=NOM DU PROJET
Le nom du projet, apparaît dans le html.

--url-du-projet=URL DU PROJET
L'url du projet, apparaît dans le html si elle est donnée.

--rép-base-projet=RÉPERTOIRE DE BASE DE PROJETS
Chemin absolu vers le répertoire de base du projet. Les liens sources seront calculés
sur la base de cette valeur.

--essai
Ne vous plaignez pas si la course n'a aucun effet.

--pdb Comme py.test --pdb.

--make-html
Produire une sortie html.

--serveur
Servez du HTML sur un serveur local.

--port de serveur=SERVER_PORT
Le port pour --serveur à utiliser.

--local-seulement
Liez le serveur à localhost uniquement.

--chemin-face=FACING_PATH
Mettre en place un VHostMonster, avec toute la confusion que cela implique.

--modifier Lorsque vous servez du HTML, autorisez la modification.

--pas de vérification
Lorsque vous servez du HTML et autorisez l'édition, ne vérifiez pas d'abord toutes les docstrings.

--add-paquet=RÉDIR.PAQUET
Ajoutez un package au système. Peut être répété pour ajouter plus d'un paquet.

--ajouter un module=MODULE
Ajoutez un module au système. Peut être répété.

--prepend-package=FORFAIT PRÉPARÉ
Imaginez que tous les packages se trouvent dans celui-ci. Peut être utilisé pour documenter une partie d'un
paquet.

--resolve-alias
Cela met à jour les références aux classes importées d'un module dans lequel elles ont été
importés vers des références à l'endroit où ils sont définis.

--abbreviate-specialcase=ABREVMAPAGE
Il s'agit d'une liste de paires clé=valeur séparées par des virgules. Où une clé correspond à un
le nom et la valeur du module sont l'abréviation souhaitée. Cela peut être utilisé pour résoudre
conflits avec l'abréviation lorsque vous avez deux modules ou plus qui commencent par le
même lettre. Exemple : twistedcaldav=tcd.

--docformat=FORMAT DOC
Dans quel format docstrings pris en charge par epydoc sont supposés se trouver.

--html-sujet=HTMLSUJETS
Le nom complet de l'objet pour lequel générer les documents d'API (par défaut : tout).

--html-pages-de-résumé
Ne générer que les pages de résumé.

--html-write-function-pages
Créez des fichiers HTML individuels pour chaque fonction et méthode. Ils ne sont pas liés à
tout code HTML généré par pydoctor, mais ils peuvent être utiles pour les liens tiers.

--html-sortie=SORTIE HTML
Répertoire dans lequel enregistrer les fichiers HTML (par défaut « apidocs »)

--html-écrivain=ÉCRIVAIN HTML
Nom en pointillé de la classe d'écriture html à utiliser (par défaut 'pydoctor.nevowhtml.NevowWriter',
nécessite l'installation de Divmod Nevow).

--html-viewsource-base=BASE HTMLSOURCE
Cela devrait être le chemin d'accès au navigateur trac pour le haut de la caisse svn que nous sommes
documenter une partie de.

--html-use-triable
Utilisez la bibliothèque JS sorttable pour créer des tableaux du contenu des packages, des modules et des classes
triable

--html-use-splitlinks
Générez du JavaScript (non gênant) pour permettre aux méthodes de classe d'être affichées soit dans un
table par classe de base ou dans une grande table.

--html-shorten-listes
Générez du JavaScript (non gênant) pour masquer certaines des entrées dans de longues listes de
par exemple des sous-classes.

--livecheck
Importez et examinez également les modules. XXX ne fonctionne pas en ce moment

-v, --verbeux
Soyez plus bruyant. Peut être répété pour plus de bruit.

-q, --silencieux
Soyez plus silencieux.

--auto Mode Automagic : analysez tous les modules et packages dans le répertoire de travail actuel
et exécutez un serveur local qui permet l'examen et l'édition des docstrings.

--verbose-sur=étape
Soyez plus bruyant pendant une étape particulière de la génération.

Utilisez pydoctor en ligne en utilisant les services onworks.net