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...

Découvrez la programmation différentiable

Magazine
Marque
GNU/Linux Magazine
Numéro
246
Mois de parution
mars 2021
Domaines
Résumé

La programmation différentiable est une nouvelle façon de penser la programmation. Le principe consiste à considérer tout un programme comme une fonction qu’on puisse différentier, et donc optimiser. Nous allons construire dans cet article les outils de base pour ce faire, et présenter la librairie JAX, qui facilite la tâche.

Concevoir des tableaux en LaTeX

Magazine
Marque
GNU/Linux Magazine
HS n°
Numéro
113
Mois de parution
mars 2021
Domaines
Résumé

Il n'est pas rare de vouloir intégrer de petits tableaux dans ses documents. LaTeX permet de créer rapidement et simplement une telle représentation d'informations. Il est également possible, avec un peu d'huile de coude, de créer des tableaux très complexes ! Ce n'est pas si compliqué... à condition de savoir comment faire !

De l'usage de l'underscore en Python

Magazine
Marque
GNU/Linux Magazine
Numéro
246
Mois de parution
mars 2021
Domaines
Résumé

Un underscore avant le nom d'un attribut ou deux, est-ce un caprice de développeur ? Et si je veux utiliser des underscores après le nom de mes variables, est-ce que cela a une signification ? Tout, tout, tout, vous saurez tout sur l'usage des underscores en Python !

Parler à un RADAR spatioporté : traitement et analyse des données de Sentinel-1

Magazine
Marque
GNU/Linux Magazine
Numéro
246
Mois de parution
mars 2021
Domaines
Résumé

Nous avions étudié comment fonctionne un RADAR pour la mesure de distance, puis d’azimut et finalement interférométrique, lors d’un déploiement depuis le sol. Nous allons appliquer ces connaissances aux données acquises par les RADAR transportés par les satellites de l’ESA Sentinel-1, librement disponibles sur le Web. Nous conclurons en installant au sol une cible coopérative qui sera parfaitement visible depuis l’espace.