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

Magazine
Marque
Linux Pratique
Numéro
81
Mois de parution
janvier 2014
Domaines


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

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

Titre 1

=======

Titre 2

-------

Titre 3

~~~~~~~

Titre 4

+++++++

Titre 5

.......

Titre 6

,,,,,,,

Voici un texte utilisant l'*italique* pour l'*accentuation* et le **gras** pour une **accentuation forte**.

- Liste à puces niveau 1

  - Liste à puces niveau 2

#) Liste numérotée, niveau 1

   #) Liste numérotée, niveau 2

Liste de définitions :

mot à définir

    définition

autre mot

    autre définition

Voici un lien vers la documentation de sphinx_, et une

Cet article est réservé aux abonnés. Il vous reste 95% à découvrir.
à partir de 21,65€ HT/mois/lecteur pour un accès 5 lecteurs à toute la plateforme
J'en profite


Articles qui pourraient vous intéresser...

Utiliser Visual Studio Code pour coder en Python

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Comme Batman a Robin, Rocket Raccoon a Groot, le développeur a l’éditeur de code. Sans son plus fidèle acolyte, impossible d’écrire la moindre ligne de code... d’où l’importance d’être toujours à la recherche de l’outil le plus efficace qui soit, quitte à délaisser un vieux compagnon de route...

Générez la documentation technique de vos projets Godot

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Découvrons comment utiliser GDScript Docs Maker pour générer automatiquement la documentation de vos projets Godot. Nous allons voir dans cet article que l’on peut simplement, à partir de notre code et de ses commentaires, avoir une documentation toujours à jour.

Implémentation du calcul symbolique et de la dérivation en Java

Magazine
Marque
GNU/Linux Magazine
Numéro
243
Mois de parution
décembre 2020
Domaines
Résumé

Les logiciels de calcul symbolique sont relativement abondants. Pour les curieux ou ceux qui voudraient intégrer ce type de fonctionnalités dans leurs propres programmes, nous allons essayer de lever une partie des mystères des théories et des problèmes qui se cachent derrière la création de ces systèmes.