Sphinx, plus d&#039;excuses pour ne pas documenter vos projets !

Tag(s)

documentation

gestion de projets

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.

S'abonner à Connect

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

Je m'abonne

Déjà abonné ? Connectez-vous

Article rédigé par

164 articles

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

Les nouveautés de Python 3.11

GNU/Linux Magazine

n°

261

janvier 2023

Par

Le 24 octobre 2022 sortait Python 3.11 et avec lui, quelques nouveautés que nous allons vous présenter. Nous en profiterons pour faire un tour des derniers changements majeurs de ces dernières années dans le langage Python.

Gérer les données temporelles, l’internationalisation et la localisation

GNU/Linux Magazine

HS n°

110

septembre 2020

Par

Python est doté d’outils simples et efficaces pour faire face à ces problématiques communes, qui peuvent parfois être un vrai casse-tête. Cet article vous présentera l’essentiel de ce qu’il faut connaître sur ces sujets.

Python « moderne » : comment coder en Python en 2020 ?

GNU/Linux Magazine

HS n°

110

septembre 2020

Par

Le langage Python évolue progressivement, version après version et de nouvelles fonctionnalités voient le jour et changent la manière dont le langage peut être appréhendé.Au-delà de la curiosité que ces changements provoquent, ils sont des révolutions silencieuses ayant un impact réel sur le style de codage.

Plus d'article de cet auteur

Les derniers articles Premiums

Les derniers articles Premium

Utilisation avancée de SQLPage

Contenu Premium

Par

Auverlot Olivier

Web

Poursuivons notre découverte de SQLPage en explorant certaines de ses fonctionnalités avancées qui sont généralement indispensables à tous sites ou applications. Dans cet article, nous allons parler de PostgreSQL, d’authentification et de gestion des droits.

Déployer un cluster AMQ Streams avec Ansible

Contenu Premium

Par

Pelisse Romain

Système

Automatiser entièrement le déploiement d’un cluster Red Hat AMQ Streams est possible… en utilisant Ansible et sa collection dédiée au produit. Démonstration par l’exemple.

Bénéficiez de statistiques de fréquentations web légères et respectueuses avec Plausible Analytics

Contenu Premium

Par

Mourey Stéphane

Web

Pour être visible sur le Web, un site est indispensable, cela va de soi. Mais il est impossible d’en évaluer le succès, ni celui de ses améliorations, sans établir de statistiques de fréquentation : combien de visiteurs ? Combien de pages consultées ? Quel temps passé ? Comment savoir si le nouveau design plaît réellement ? Autant de questions auxquelles Plausible se propose de répondre.

Quarkus : applications Java pour conteneurs

Contenu Premium

Par

Pelisse Romain

Système

Initié par Red Hat, il y a quelques années le projet Quarkus a pris son envol et en est désormais à sa troisième version majeure. Il propose un cadre d’exécution pour une application de Java radicalement différente, où son exécution ultra optimisée en fait un parfait candidat pour le déploiement sur des conteneurs tels que ceux de Docker ou Podman. Quarkus va même encore plus loin, en permettant de transformer l’application Java en un exécutable natif ! Voici une rapide introduction, par la pratique, à cet incroyable framework, qui nous offrira l’opportunité d’illustrer également sa facilité de prise en main.