Sphinx, plus d'excuses pour ne pas documenter vos projets !

Magazine
Marque
SysOps Pratique
Numéro
81
Mois de parution
janvier 2014
Spécialité(s)


Résumé
Sphinx est un outil très puissant permettant de documenter un projet. Il s'appuie sur le formidable format reStructuredText, qui est un langage de balisage léger, ainsi que sur quelques commandes supplémentaires. Il se prend en main assez rapidement et détonne par sa simplicité d'utilisation et sa puissance.

1. Le format reStructuredText

Le format reStructuredText (souvent abrégé en reST ou ReST, ou encore RST, à ne pas confondre avec REST) est un langage de balisage léger, proche de l'idée du WYSIWYG (what you see is what you get). En effet, il suffit de décorer son texte avec des caractères particuliers pour les formater. Voici un pot-pourri permettant de voir rapidement quelles sont les principales fonctionnalités :

===================

Titre du document

===================

------------------------

Sous-titre du document

------------------------

La suite est réservée aux abonnés. Il vous reste 95% à découvrir.
  • Accédez à tous les contenus de Connect en illimité
  • Découvrez des listes de lecture et des contenus Premium
  • Consultez les nouveaux articles en avant-première
Envie de lire la suite ? Rejoignez Connect
Je m'abonne maintenant


Article rédigé par

Par le(s) même(s) auteur(s)

Les outils pour les développeurs Python

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
110
Mois de parution
septembre 2020
Spécialité(s)
Résumé

Pouvoir déboguer son code en toutes circonstances, le tester à chaque amélioration, suivre son utilisation et son bon fonctionnement et être capable d’en optimiser les points faibles.Ce sont des enjeux importants que tous les développeurs connaissent. Voici les outils pour y parvenir.

Introduction au dossier : Python 3 pour débuter en programmation

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
110
Mois de parution
septembre 2020
Résumé

Comment progresser en Python ? Quels sont les indispensables à maîtriser ? Comment être certain de toujours développer un code de plus grande qualité, tout en améliorant sa connaissance de ce langage vraiment époustouflant ? Quels sont les piliers du langage sur lesquels on peut se reposer et où faut-il mettre son effort dans de nouveaux apprentissages ?

Gestion de système de fichiers

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
110
Mois de parution
septembre 2020
Spécialité(s)
Résumé

À l’origine, Python était un langage spécifiquement écrit pour répondre à des problématiques système, dont la gestion du système de fichiers est une part importante. Depuis, il n’a eu de cesse de s’améliorer, y compris dans les toutes dernières versions.

Les listes de lecture

Python niveau débutant

9 article(s) - ajoutée le 01/07/2020
Vous désirez apprendre le langage Python, mais ne savez pas trop par où commencer ? Cette liste de lecture vous permettra de faire vos premiers pas en découvrant l'écosystème de Python et en écrivant de petits scripts.

Au pays des algorithmes

11 article(s) - ajoutée le 01/07/2020
La base de tout programme effectuant une tâche un tant soit peu complexe est un algorithme, une méthode permettant de manipuler des données pour obtenir un résultat attendu. Dans cette liste, vous pourrez découvrir quelques spécimens d'algorithmes.

Analyse de données en Python

10 article(s) - ajoutée le 01/07/2020
À quoi bon se targuer de posséder des pétaoctets de données si l'on est incapable d'analyser ces dernières ? Cette liste vous aidera à "faire parler" vos données.
Plus de listes de lecture