Sphinx

Lorsqu'il est créé pour la première fois, son but principal était de servir de générateur de documentation pour Python s 'propre code.
Depuis lors, le projet a atteint le statut de culte dans le monde du développement, étant l'une des influences les plus référencées dans les générateurs de documentation plus automatiques autour, indépendamment de la langue.
Aujourd'hui, en plus juste Python, Sphinx peut également être utilisé avec le code C et C ainsi.

Ce qui est nouveau dans cette version:

• Ajoutez les directives et les rôles dépanneurs au domaine de la C: directive `` cpp: var`` comme alias pour `` cpp: member``, rôle ``: cpp: var`` comme alias pour ``: cpp: membre ``, `any` et le rôle de contre-référence à une quelconque ++ declaraction C.
• L': confval: `valeur de config source_suffix` peut maintenant être une liste de plusieurs suffixes
.
• Ajouter la possibilité de spécifier les analyseurs de source par source avec le suffixe: confval:. `Valeur de config source_parsers`
• Un nouveau constructeur, AppleHelpBuilder, a été ajoutée qui construit Aide Apple Books.

Ce qui est nouveau dans la version 1.2.3 / 1.3b3:

• Ajout `` sphinx.version_info`` tuple pour le contrôle programmatique de la version Sphinx.

Ce qui est nouveau dans la version 1.1.3:

• Correction d'un crash avec certains paramètres de: confval:. `Modindex_common_prefix`
• Correction manipulation des `` et `` -D`` les options -A`` sur Python 3.
• Reconnu et avertir toctrees circulaires, au lieu de courir dans des erreurs de récursion.
• Restaurer compatibilité avec docutils tronc.
• Liens d'entrée d'index HtmlHelp fixe à nouveau.
• inheritance_diagram fixe la levée des erreurs d'attributs sur les commandes intégrées.
• Correction de plantages lors de la mise des commentaires ou des termes isolés dans un glossaire.
• aide HTML fixe cartographie langue / de codage pour toutes les langues prises en charge Sphinx.

Ce qui est nouveau dans la version 1.1:

• Fonctionnalités ajoutées:
• Ajouté Python 3.x soutien.
• Nouveaux constructeurs et sous-système.
• changements incompatibles:
• L': premier: dir: `py: directive module` ne sort pas de sa valeur de l'option` `platform`` plus. (Il était la seule chose que la directive a fait la production, et donc tout à fait incompatible.)
• Prise en charge supprimée pour les anciennes versions de dépendance.
• Nouveaux paramètres régionaux:
• locale suédoise ajouté.
• locale iranienne ajouté.
• locale lettone ajouté.
• locale népalais ajouté.
• Ajout locale coréenne.
• locale estonienne ajouté.

Ce qui est nouveau dans la version 1.0.8:

• tracebacks Fix pour AttributeErrors en génération AutoSummary.
• Fixer le `` abbr`` rôle lorsque l'abréviation des sauts de ligne a en elle.
• Fixer les liens vers les résultats avec les types d'objets personnalisés chercher.
• les numéros de ligne Fix signalés dans les avertissements à propos des références indéfinies.
• Fix C ++ définitions de tableau et arguments de modèle qui ne sont pas des noms de type.
• Laissez les notes en-têtes de section de la production de LaTeX.
• Laissez mots-clés pour être reliés par intersphinx.
• Laissez caractères Unicode dans la liste de la production noms symboliques.
• Ajouter visiteurs factices pour les nœuds de graphviz pour le texte et l'homme.
• Correction d'un bug fichier image de duplication.
• Fix analyse de plusieurs signatures en C de la domaine.
• Ignorer les fichiers de verrouillage Emacs lors de la recherche pour les fichiers source.
• Laissez l'extension .pyw pour les modules importables dans autodoc.
• Utilisez `` $ (MAKE) `` QuickStart généré Makefiles.
• Assurez encadré largeur de la boîte de recherche dans les navigateurs conformes.
• Correction d'espacement des figures centrées dans la sortie HTML.
• coder en toute sécurité des messages SphinxError lors de leur impression sur sys.stderr.
• Fix LaTeX erreur de sortie avec un document sans sections, mais une cible de lien.
• correctement traiter intégrés dans les descripteurs de méthode que les méthodes dans autodoc.
• Arrêter monkeypatching le module de TextWrap Python.
• VIEWCODE fonctionne désormais correctement avec les fichiers sources qui ont encodage non-ASCII.
• Respecter l'option de drapeau `` noindex`` dans py:. Directives du module
• IndexErrors Fix quand y compris inexistantes lignes avec: première: dir: `literalinclude`.

Cordes
• Respect fonction personnalisée / paramètre de méthode séparation.
• incompatibilité Fix JS avec jQuery & gt;. = 1.5
• Correction à double encodage fait lors de l'écriture HTMLHelp .hhk fichiers.
• Ne pas appliquer SmartyPants dans des blocs-littérales analysées.
• C de la domaine prend désormais en charge les définitions de tableau.

Ce qui est nouveau dans la version 1.0.6:

• Fix retraçage dans le domaine Python pour objectifs vides de références croisées.
• Correction des problèmes d'affichage de bloc sur les navigateurs Chrome littérales.
• Support tri d'un nombre limité de caractères accentués de l'indice général et le glossaire.
• Essayer décodage `` et `` -D`` arguments -A`` de ligne de commande avec l'encodage préféré de la locale.
• Observez: confval:. `Locale_dirs` lorsque vous cherchez le fichier traductions JS
• Ajouter code spécial pour un meilleur support des documents japonais dans le constructeur de LaTeX.
• Régression du # 77: Si il ya un seul paramètre donné par ``: param:. `` Balisage, la liste de la balle est maintenant supprimée nouveau
• Correction manquant sauts de paragraphe de la production de LaTeX dans certaines situations.
• Emettre l'événement `` autodoc-processus-docstring`` même pour les objets sans docstring afin qu'il puisse ajouter du contenu.
• Dans le générateur de LaTeX, non seulement les blocs littérales nécessitent une manipulation de table différente, mais aussi un certain nombre d'autres éléments de bloc type liste.
• tracebacks de fixer dans l'extension de VIEWCODE pour les objets Python qui ne possèdent pas une signature valide.
• Fix reportings étranges de numéros de ligne pour les avertissements générés par docstrings de AutoDoc-inclus, en raison de comportement différent en fonction de la version docutils.
• Plusieurs corrections dans le domaine C ++.

Ce qui est nouveau dans la version 1.0.5:

• Ajout de styles CSS requises par docutils 0,7 pour les images et chiffres alignés.
• Dans le Makefile généré par la sortie de LaTeX, ne supprimez pas les fichiers pdf sur le nettoyage; ils pourraient être tenus images.
• sortie Fix LaTeX généré pour les blocs de ligne.
• Laissez `` .pyw`` comme une extension de fichier source.

Ce qui est nouveau dans la version 1.0.4:

• Ouvrez inventaires intersphinx en mode binaire sur Windows, depuis la version 2 contient des données zlib-comprimé.
• Laissez donnant URI non-locaux pour les fichiers JavaScript, par exemple, dans le prolongement jsmath.
• retraçage Fix quand `` intersphinx_mapping`` est vide.

Ce qui est nouveau dans la version 1.0.3:

• Fix interne vs. distinction lien externe pour des liens provenant d'un docutils de table de contenu.
• Fixer l'option `` maxdepth`` pour le `` toctree () `` modèle appelable lorsqu'il est utilisé avec `` effondrement = True``.
• Correction du crash analyse Python listes d'arguments contenant entre parenthèses dans les littéraux de chaîne.
• Correction régression lors de la construction docs LaTeX avec des chiffres qui ne disposent pas des légendes.
• Fix schémas de succession pour les classes qui ne sont pas picklable.
• Présentez couleur de fond séparé pour le bouton latéral de l'effondrement, ce qui rend plus facile à voir.
• Correction de petits bogues de mise en page dans plusieurs thèmes intégrés.

Ce qui est nouveau dans la version 1.0.2:

• Correction des renvois à des objets de types ajoutés par l': func:. `~ Fonction API .Sphinx.add_object_type`
• Gestion de Fix des types de champs de doc pour les types de directives différentes.
• Autoriser rupture de longues signatures, en continuant avec des sauts de ligne à jeu-échappé.
• Fix style indésirable de références de domaine C (en raison d'un conflit d'espace de noms avec des styles pygments).
• Laissez références à PEP et RFC avec des ancres explicites.
• références Fix LaTeX à chiffres.
• Lorsque vous effectuez une recherche non exacte, un match que le type d'objet donné.
• Appliquer la recherche non-exacte de cibles de référence Python avec `` .name`` pour les modules trop.
• Correction du crash lors de la duplication d'un paramètre dans une liste de champ d'information.
• Correction régler le rôle à un défaut fourni par le `` l'extension oldcmarkup``.
• Correction du crash lors json-py est installé, qui fournit un module `` json`` mais est incompatible avec simplejson.
• Gestion de Fix de la cible en nommant intersphinx.
• Evacuation des Fix de ``! `` Pour tous les rôles de références croisées.

Ce qui est nouveau dans la version 1.0.1:

• Correction des noms de cibles générées pour les objets de domaine reste; ils ne sont pas dans le même espace.
• Ajouter langue bengali.
• Correction d'un bug lors de l'analyse des noms d'objets JavaScript.
• Fix immeuble avec SingleHTMLBuilder lorsqu'il n'y a pas toctree.
• noms d'affichage de Fix pour des objets liés par intersphinx avec des objectifs explicites.
• Fix construction avec le constructeur JSON.
• hyperrefs de fixer dans les descriptions d'objets pour LaTeX.

Ce qui est nouveau dans la version 1.0:

• Général:
• Ajout d'un mode "pinailler" qui émet des avertissements pour toutes les références manquantes. Il est activé par l'option:: `de ligne de commande ou de la -n`: confval:.` Valeur de config de nitpicky`
• Ajout `` cible latexpdf`` QuickStart Makefile.
• Markup:
• L': premier: rôle: `menuselection` et: premier: rôle:.` Rôles guilabel` prennent désormais en charge les accélérateurs esperluette
• Nouvelle syntaxe de champ doc plus compact est maintenant reconnu: ``: nom du type de param:. Description``
• Ajout d'option `` onglet-width`` à: premier: dir:. `Directive literalinclude`
• Ajout d'option `` de titlesonly`` à: premier: dir:. `Directive toctree`
• Ajout de la `` et `` prepend`` les options append`` à l': premier: dir:. `Directive literalinclude`
• Tous DOCINFO métadonnées est maintenant mis en métadonnées du document, pas seulement l'auteur.
• L': premier: rôle: `rôle ref` peut maintenant référencer aussi des tables de légende
.
• L': premier: dir:. `Directive include` prend désormais en charge les chemins absolus, qui sont interprétés comme relatif au répertoire source
• Dans le domaine Python, références comme ``: func: `. .name``` Maintenant regarder pour faire correspondre les noms avec préfixe si aucune correspondance directe se trouve
• Configuration:
• Ajouté: confval:. `Valeur de config rst_prolog`
• Ajouté: confval:. `Valeur html_secnumber_suffix` de configuration pour contrôler la section format de numérotation
• Ajouté: confval:. `Valeur html_compact_lists` de configuration pour contrôler les listes compactes docutils disposent
• L': confval: `valeur de config de html_sidebars` peut maintenant contenir des motifs que les clés et les valeurs peuvent être des listes qui sélectionnent explicitement quels modèles de la barre latérale doivent être rendus. Cela signifie que le contenu de la barre latérale builtin peuvent être inclus que de manière sélective.
• : confval:. `Html_static_path` peuvent maintenant contenir des entrées de fichiers simples
• La nouvelle valeur de config universelle: confval: `exclude_patterns` rend la vieille: confval:` unused_docs`,: confval: `exclude_trees` et: confval:.` Exclude_dirnames` obsolète
• Ajouté: confval:. `Valeur de config de html_output_encoding`
• Ajout de l': confval: `valeur de config latex_docclass` et a fait l'option de documentclass" de twoside "substituable par" oneside "
.
• Ajout de l': confval:. `Valeur de config trim_doctest_flags`, ce qui est vrai par défaut
• Ajouté: confval:. `Valeur de config de html_show_copyright`
• Ajouté: confval: `latex_show_pagerefs` et: confval:.` Valeurs de configuration latex_show_urls`
• Le comportement de: confval: `html_file_suffix` légèrement changé: la chaîne vide signifie maintenant" aucun suffixe "au lieu de" suffixe par défaut ", l'utilisation` `None`` pour" suffixe par défaut "
.
• Nouveaux constructeurs:
• Ajout d'un constructeur pour le format Epub.
• Ajout d'un constructeur pour les pages de manuel.
• Ajout d'un générateur HTML fichier unique.
• sortie HTML:

Rôles
• Inline obtiennent maintenant une classe CSS avec leur nom, permettant styles de personnaliser leur apparence. Rôles spécifiques au domaine obtiennent deux classes, `` et `` domain`` domaine rolename``.
• Références maintenant obtenir la classe `` internal`` si elles sont internes à l'ensemble du projet, par opposition à interne à la page en cours.
• Les références externes peuvent être décorées différemment avec la nouvelle option de thème `` externalrefs`` pour le thème par défaut.
• Dans le thème par défaut, la barre latérale peut maintenant être faite expérimentalement pliable en utilisant la nouvelle option `` collapsiblesidebar`` thème.
• Toctrees sont désormais enveloppés dans un `` div`` tag avec la classe `` toctree-wrapper`` en sortie HTML.
• L': données:. `Toctree` appelable dans les modèles a maintenant un` `mot-clef argument maxdepth`` pour contrôler la profondeur de l'arbre généré
• L': données:. `Toctree` appelable dans les modèles accepte maintenant un` `mot-clef argument titles_only``
• Ajout de `` bloc htmltitle`` dans le modèle de mise en page.
• Dans la recherche JavaScript, permet la recherche de noms d'objets, y compris le nom du module, comme `` sys.argv``.
• Ajout d'un nouveau thème `` haiku``, inspiré par le mode d'emploi Haiku OS.
• Ajout nouveau thème `` nature``.
• Ajout d'un nouveau thème `` agogo``, créé par Andi Albrecht.
• Ajout d'un nouveau thème `` scrolls``, créé par Armin Ronacher.
• Ajout d'une option `` thème visitedlinkcolor`` au thème par défaut.
• Amélioration de la réactivité de la page de recherche en chargeant thesearch indice de manière asynchrone.
• API d'extension:
• Ajout: événement:. `Html-collect-pages`
• Ajouté: confval: `valeur de config et needs_sphinx`: meth:.` ~ Méthode sphinx.application.Sphinx.require_sphinx` application API
• Ajouté: meth:. `~ Méthode sphinx.application.Sphinx.add_stylesheet` application API
• Extensions:
• Ajout de l': mod: `~ extension sphinx.ext.viewcode`
.
• Ajout de l': mod: `~ extension sphinx.ext.extlinks`
.
• Ajout du support pour la source ordre des membres dans autodoc, avec `` autodoc_member_order = 'bysource'``.
• Ajouté: confval:. `Autodoc_default_flags` valeur de config, qui peut être utilisé pour sélectionner des drapeaux par défaut pour toutes les directives de AutoDoc
• Ajout d'une voie à intersphinx de se référer aux étiquettes nommées dans d'autres projets, et de préciser le projet que vous souhaitez créer un lien.
• Autodoc peuvent maintenant instance de document attributs affectés dans `` méthodes __init__``.
• De nombreuses améliorations et corrections à l': mod:. `~ Extension sphinx.ext.autosummary`, grâce à Pauli Virtanen
• L': mod: `~ extension sphinx.ext.graphviz` peut SVG maintenant sortie plutôt que des images PNG, contrôlée par le confval:.` Valeur de config graphviz_output_format`
• Ajout d'option `` de alt`` à: premier: dir:. `Directives d'extension graphviz`
• Ajout de l'argument `` exclude`` à: func:. `.autodoc.between`
• Traductions:
• Ajout de la traduction croate, grâce à Bojan Mihelac.
• Ajout de la traduction turque, grâce à Firat Ozgul.
• Traduction ajoutée catalan, grâce à Pau Fernandez.
• Ajout de la traduction en chinois simplifié.
• Ajout de la traduction danoise, grâce à Hjorth Larsen.
• Ajout de la traduction lituanienne, grâce à Dalius Dobravolskas.

Ce qui est nouveau dans la version 1.0b1:

• Support pour les domaines a été ajouté. Un domaine est un ensemble de directives et de rôles que tous décrivent des objets appartenant ensemble, par exemple, éléments d'un langage de programmation. Quelques domaines builtin sont fournis: - Python - C - C ++ - JavaScript - reStructuredText
• Le vieux balisage pour la définition et la reliant aux directives C ne fonctionne plus sans activer le `` l'extension oldcmarkup``.
• Prise en charge supprimée pour les anciennes versions de dépendance.
• éléments obsolètes supprimés.

Ce qui est nouveau dans la version 0.6.5:

• Dans autodoc, fixer l'omission de certains membres de module explicitement documentées en utilisant les commentaires de documentation.
• Fix culture de la barre de défilement de la barre latérale avec option `` stickysidebar`` du thème par défaut.
• Toujours générer des sauts de ligne UNIX dans le Makefile de démarrage rapide.
• Fix courir avec `` -C`` sous Windows.
• Dans autodoc, permet la personnalisation de la signature d'un objet où le mécanisme intégré échoue.
• sortie de Fix pour les listes numérotées avec des valeurs de départ dans LaTeX.
• Faites le `` start-after`` et `` options de fin before`` à la `` travaux de directive literalinclude`` correctement si pas utilisés ensemble.
• Fix génération de lien dans le constructeur de LaTeX.

Ce qui est nouveau dans la version 0.6.4:

• Amélioration de la manipulation des chaînes non-Unicode dans la configuration.
• OSErrors de capture se produisant lors de l'appel graphviz avec des arguments, il ne comprend pas.
• Restaurer compatibilité avec Pygments & gt;. = 1.2
• Fix échapper des cibles hyperref en sortie de LaTeX.
• liens Fix générés par le ``: doc: ``. Rôle pour la sortie de LaTeX
• Gagner de todo noeuds après l'ensemble du document a été lu; ce qui permet de placer des références de substitution todo articles.
• Ne pas ignorer un `` valeur de config de today`` explicite dans une version LaTeX.
• Le `` texte de alt`` des schémas de succession est maintenant beaucoup plus propre.
• Ignorer images dans les titres de section lors de la génération lien légendes.
• Messages de soutien d'exception dans les `` blocs de testoutput`` de l'extension `` de doctest``.
• blocs de ligne sont décorées correctement dans la sortie HTML.
• Fait le travail de `valeur de config locale_dirs``` nouveau.
• `` valeurs html_context`` donnés sur la ligne de commande par des `` -A`` ne devraient pas remplacer d'autres valeurs données dans conf.py.
• Correction d'un bug empêchant les reconstructions supplémentaires pour le `` constructeur dirhtml``.
• Fixer le calandrage de citations dans certains blocs littérales.
• chemin de Fix à l'index de recherche pour le `` constructeur dirhtml``.
• Correction d'un problème de compatibilité Jython: faire de la dépendance à l'égard de la `` module de parser`` option
.
• Dans autodoc, rattraper toutes les erreurs qui se produisent sur module import, et pas seulement `` ImportError``.
• Fixer le traitement des non-données, mais non-méthode descripteurs dans autodoc.
• Lors de la copie de fichiers fois, ignorer OSErrors soulevées par `` os.utime () ``.

Exigences :

• Pygments 1.2 ou supérieur
• Jinja 2.3 ou supérieur
• Docutils 0/7 ou plus