Documentation du Dr FRAPPE

Ce wiki regroupe les résultats de mes expériences en informatique accumulés au cours de mes recherches sur le net.

Dans la mesure du possible, j'ai cité mes sources ; il en manque certainement… :-)

Ceci est une ancienne révision du document !


PyWeb : un outil de programmation littéraire en Python

Introduction

La programmation lettrée tente de réconcilier les besoins opposés d'une présentation claire pour tous avec les problèmes techniques de la création de code fonctionnel.d'outils.

La présentation pour tous nécessite des techniques de composition étendues et sophistiquées.

En outre, la logique du discours narratif d'une présentation peut ne pas suivre le code source tel qu'il a été conçu pour le compilateur.

L'outil de programmation pyWeb combine les actions weave et tangle sur des fichiers source d'un document.

Il est indépendant de tout balisage de document ou du langage source.

Il utilise un ensemble simple de balises de marquage pour définir des morceaux de code et de documentation.

Le fichier pyweb.w est la source des divers fichiers de module et script pyweb, plus le fichier pyweb.html.

Les différents fichiers de code source sont créés en appliquant une opération weave au fichier .w.

La documentation finale est créée en appliquant une opération weave au fichier .w.

Pré-requis

  • Installez le paquet docutils ou en ligne de commande :

    $ sudo apt install docutils

Installation

Pour installer le module pyweb,

Configuration

Utilisation

Production de documents

La création de la documentation utilise le balisage RST et nécessite docutils.

Lancez :

$ python3 -m pyweb pyweb.w
$ rst2html.py pyweb.rst pyweb.html

Désinstallation

Voir aussi


Basé sur « Article » par Auteur.