À quoi sert la classe « ltxdoc » ?#

  • La classe ltxdoc est un peu particulière : elle sert à produire de la documentation pour les packages ou les classes. Le package ou la classe sont alors fournis sous forme d’un «kit d’installation», contenant un fichier .ins et un fichier .dtx ou .doc. Le premier contient les sources des fichiers nécessaires ainsi que la documentation (on parle de Literate Programming). Ces fichiers pourront être extraits en compilant le second fichier dit « d’installation ».

1.  Que puis-je lire sur la classe « ltxdoc » ?#

  • La documentation de la classe ltxdoc est disponible dans toutes les distributions, sous la forme d’un fichier .dtx nommé ltxdoc.dtx. Compilé, ce fichier produira la documentation de la classe ltxdoc sous la forme du fichier ltxdoc.dvi.

Le Companion contient également une section à propos de la classe ltxdoc.

2.  Y a-t-il des alternatives à « ltxdoc » ?#

  • Oui, plusieurs classes ont été développées récemment pour remplacer ltxdoc en y ajoutant des fonctionnalités. Notamment :

  • skdoc de Simon Sigurdhsson, activement développée,

  • ydoc de Martin Scharrer, qui est en version alpha et dont le développement semble s’être arrêté en 2011.