Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

  1. #1
    Rédacteur/Modérateur

    Avatar de deusyss
    Homme Profil pro
    Expert Python
    Inscrit en
    mars 2010
    Messages
    1 659
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : France, Ille et Vilaine (Bretagne)

    Informations professionnelles :
    Activité : Expert Python
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : mars 2010
    Messages : 1 659
    Points : 8 148
    Points
    8 148

    Par défaut [article] Présentation de l'outil SPHINX

    Bonjour à tous,

    Je vous invite à découvrir l'outil de documentation Sphinx grâce à cet article.

    Bonne lecture à tous
    "La connaissance appartient à tout le monde" (Film Antitrust)

    Tout le nécessaire pour Python:
    *News/Accueil *Cours/tutoriels *FAQ
    *Forums *Outils dédiés *Mon espace personnel avec mes Articles, Cours et Tutoriels

  2. #2
    Membre expérimenté
    Avatar de Luke spywoker
    Homme Profil pro
    Etudiant informatique autodidacte
    Inscrit en
    juin 2010
    Messages
    1 077
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France

    Informations professionnelles :
    Activité : Etudiant informatique autodidacte

    Informations forums :
    Inscription : juin 2010
    Messages : 1 077
    Points : 1 740
    Points
    1 740

    Par défaut

    Salut deusyss,

    j'ai parcourus ton tutoriel et moi qui croyais presque tout savoir sur sphinx (ayant lu attentivement la documentation officiel) je suis étonner de ce que j'ai découvert dans ton tutoriel.

    Je vais me l'imprimer, le lire complètement et l'archiver avec mes autres tutoriels.

    Encore une fois du beau travail et grand merci au nom de la communauté python envers laquelle ton dévouement est admirable.

    Si je puis me permettre, j'ai écrit un tutoriel sur les bases de la programmation 3D avec (py)OpenGL générer avec sphinx, sous forme de pages *.html, dont vous pouvez regarder le rendu et les sources (En ReST) sont compris dans le zip, si ça peut vous aider.

    Bonne continuation.
    Pour faire tes armes:
    Use du présent pour construire ton futur sinon use de ce que tu as appris auparavant.
    Et sois toujours bien armé avant de te lancer.
    Le hasard ne sourit qu'aux gens préparés...
    Site: Website programmation international (www.open-source-projects.net)
    Site: Website imagerie 3D (www.3dreaming-imaging.net)
    Testez aux moins pendant une semaine l'éditeur avec terminaux intégrées it-edit Vous l'adopterai sûrement !
    FUN is HARD WORK !!!

  3. #3
    Rédacteur/Modérateur

    Avatar de deusyss
    Homme Profil pro
    Expert Python
    Inscrit en
    mars 2010
    Messages
    1 659
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : France, Ille et Vilaine (Bretagne)

    Informations professionnelles :
    Activité : Expert Python
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : mars 2010
    Messages : 1 659
    Points : 8 148
    Points
    8 148

    Par défaut

    Bonjour Luke,

    Merci beaucoup pour ton retour. Effectivement ta documentation est un très bon exemple de rendu. Et le sujet est intéressant en plus.

    Heureux de t'avoir permis d'apprendre encore un peu plus, et de te voir de retour
    "La connaissance appartient à tout le monde" (Film Antitrust)

    Tout le nécessaire pour Python:
    *News/Accueil *Cours/tutoriels *FAQ
    *Forums *Outils dédiés *Mon espace personnel avec mes Articles, Cours et Tutoriels

  4. #4
    Membre expérimenté
    Avatar de Luke spywoker
    Homme Profil pro
    Etudiant informatique autodidacte
    Inscrit en
    juin 2010
    Messages
    1 077
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Localisation : France

    Informations professionnelles :
    Activité : Etudiant informatique autodidacte

    Informations forums :
    Inscription : juin 2010
    Messages : 1 077
    Points : 1 740
    Points
    1 740

    Par défaut

    Pour ceux que ça intéresse j'aimerai soulever les points suivant en complément:

    En tant que python je conseille vivement le ReST car il permet de générer des documents dans divers formats (*pdf, *.html, Latex, et même des manpages) d'après une syntaxe ultra simple, grâce a des outils comme:
    rst2pdf,
    rst2html,
    rst2man
    et sphinx qui regroupes ces formats de sorties comme préciser dans le tutoriel de deusyss mais la sortie et les possibilités de configuration sont différentes.

    Et puis le ReST est le langage de documentation officiel par convention de python:
    pour preuve le documentation officiel de python est générer avec le ReST et sphinx.

    Il existe sous Linux un éditeur spécialiser dans le ReST et MarkDown qui s'appelle ReText.
    Qui permet d'écrire du ReST, d'avoir un aperçu en HTML et des traceback en cas d'erreur (mécanique que sphinx pourvoie aussi).

    Le ReST ou le MarkDown peuvent tous les deux êtres utilisés pour créer la page d'accueil de vos projets déposer sur github en tant que readme.rst (ReST) ou readme.md (MarkDown).


    Le ReST peut également être utiliser pour créer la page d'accueil de vos modules sur PyPI (Python Package Index) en fournissant un document au format ReST comme argument de description longue comme expliquer dans mon tutoriel intituler: Uploader un module sur PyPI avec distutils document générer avec rst2pdf.


    Pour avoir un aperçus du rendus:

    rendez-vous a la page de mon module pyglut (module d'aide a la programmation 3D avec pyopengl) sur PyPI.

    Ou sur la page github de pyglut dont la documentation est également générée avec sphinx, avec un index et une mécanique de recherches, le tout grâce a sphinx.
    Pour faire tes armes:
    Use du présent pour construire ton futur sinon use de ce que tu as appris auparavant.
    Et sois toujours bien armé avant de te lancer.
    Le hasard ne sourit qu'aux gens préparés...
    Site: Website programmation international (www.open-source-projects.net)
    Site: Website imagerie 3D (www.3dreaming-imaging.net)
    Testez aux moins pendant une semaine l'éditeur avec terminaux intégrées it-edit Vous l'adopterai sûrement !
    FUN is HARD WORK !!!

  5. #5
    Rédacteur/Modérateur

    Avatar de deusyss
    Homme Profil pro
    Expert Python
    Inscrit en
    mars 2010
    Messages
    1 659
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : France, Ille et Vilaine (Bretagne)

    Informations professionnelles :
    Activité : Expert Python
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : mars 2010
    Messages : 1 659
    Points : 8 148
    Points
    8 148

    Par défaut

    Salut Luke,

    Merci beaucoup pour ces petite precision, et ce logiciel que je ne connaissais pas
    "La connaissance appartient à tout le monde" (Film Antitrust)

    Tout le nécessaire pour Python:
    *News/Accueil *Cours/tutoriels *FAQ
    *Forums *Outils dédiés *Mon espace personnel avec mes Articles, Cours et Tutoriels

  6. #6
    Expert éminent sénior
    Avatar de Lana.Bauer
    Femme Profil pro
    Administrateur systèmes et réseaux
    Inscrit en
    novembre 2012
    Messages
    5 382
    Détails du profil
    Informations personnelles :
    Sexe : Femme
    Localisation : Allemagne

    Informations professionnelles :
    Activité : Administrateur systèmes et réseaux

    Informations forums :
    Inscription : novembre 2012
    Messages : 5 382
    Points : 12 094
    Points
    12 094

    Par défaut

    Félicitations !

  7. #7
    Rédacteur/Modérateur

    Avatar de deusyss
    Homme Profil pro
    Expert Python
    Inscrit en
    mars 2010
    Messages
    1 659
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : France, Ille et Vilaine (Bretagne)

    Informations professionnelles :
    Activité : Expert Python
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : mars 2010
    Messages : 1 659
    Points : 8 148
    Points
    8 148

    Par défaut

    Merci
    "La connaissance appartient à tout le monde" (Film Antitrust)

    Tout le nécessaire pour Python:
    *News/Accueil *Cours/tutoriels *FAQ
    *Forums *Outils dédiés *Mon espace personnel avec mes Articles, Cours et Tutoriels

  8. #8
    Modérateur

    Avatar de MaitrePylos
    Homme Profil pro
    DBA & Dev PHP
    Inscrit en
    juin 2005
    Messages
    5 005
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 46
    Localisation : Belgique

    Informations professionnelles :
    Activité : DBA & Dev PHP
    Secteur : Service public

    Informations forums :
    Inscription : juin 2005
    Messages : 5 005
    Points : 11 159
    Points
    11 159

    Par défaut

    Aujourd'hui je me dit bon allez je me met à Sphinx pour mon projet de doc et voila le tuto dont je rèvais

    Merci.

  9. #9
    Rédacteur/Modérateur

    Avatar de deusyss
    Homme Profil pro
    Expert Python
    Inscrit en
    mars 2010
    Messages
    1 659
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : France, Ille et Vilaine (Bretagne)

    Informations professionnelles :
    Activité : Expert Python
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : mars 2010
    Messages : 1 659
    Points : 8 148
    Points
    8 148

    Par défaut

    De rien, heureux que cela plaise.

    Petite info complémentaire: si j'explique comment autodocumenter son code avec Python, il faut savoir que cela est a priori aussi possible avec d'autre langage. Mais je ne suis pas catégorique, n'ayant jamais essayé.
    "La connaissance appartient à tout le monde" (Film Antitrust)

    Tout le nécessaire pour Python:
    *News/Accueil *Cours/tutoriels *FAQ
    *Forums *Outils dédiés *Mon espace personnel avec mes Articles, Cours et Tutoriels

  10. #10
    Rédacteur/Modérateur

    Avatar de deusyss
    Homme Profil pro
    Expert Python
    Inscrit en
    mars 2010
    Messages
    1 659
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : France, Ille et Vilaine (Bretagne)

    Informations professionnelles :
    Activité : Expert Python
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : mars 2010
    Messages : 1 659
    Points : 8 148
    Points
    8 148

    Par défaut

    Je me permets de signaler, parmi les nombreuses directives existantes et non abordées dans ma doc, l'existance de ".. versionadded:: X.X.X".

    J'ai eu à utiliser cela dans mon travail récemment, après que l'article soit publié

    Cela peux toujours servir
    "La connaissance appartient à tout le monde" (Film Antitrust)

    Tout le nécessaire pour Python:
    *News/Accueil *Cours/tutoriels *FAQ
    *Forums *Outils dédiés *Mon espace personnel avec mes Articles, Cours et Tutoriels

Discussions similaires

  1. Réponses: 8
    Dernier message: 30/08/2006, 23h10

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo