Welcome to Évariste’s documentation!

Given a git repository (or any directory), Évariste has two purposes:

• compile every file (à la make, with a different configuration);

• generate an HTML page presenting every file (both compiled file and source file), as an annotated directory tree.

For instance, Évariste turns a git repository of hundreds of LaTeX files into an HTML page with annotated source and compiled files.

Layout of this documentation

• Installation is explained in the next section.

• The basic concepts of Évariste are explained in Getting started.

• A more thorough user documentation is available in User documentation.

• Évariste is extensible. Learn about existing plugins, as well as how to write your own plugins, in Plugins.

• Évariste comes with a few helpers tools, which are described in evs tools.

• Developers might want to have a glance at Library documentation.

Enjoy!

• Use case
  • TL;DR
  • More details, please?
• Download and install
• User documentation
  • Getting started
  • Usage
  • Setup file
  • Per-file and per-directory configuration files
  • String formatting
  • Source
• Plugins
  • Mandatory plugins
  • Action plugins
  • Misc plugins
  • Logging plugins
  • Renderer plugins
  • VCS plugins
  • Write your own plugin
  • Plugin paths
• evs tools
  • evs cache — Cache management
  • evs plugins — Plugin management
  • evs compile — Run Évariste
  • Write your own
• Library documentation
  • evariste.builder
  • evariste.hooks
  • evariste.plugins
  • evariste.shared
  • evariste.tree
  • evariste.utils

Indices and tables

• Index

• Module Index

• Search Page

Je ne sais pas le reste

C’est que malheureusement on ne se doute pas que le livre le plus précieux du plus savant serait celui où il dirait tout ce qu’il ne sait pas, c’est qu’on ne se doute pas qu’un auteur ne nuit jamais tant à ses lecteurs que quand il dissimule une difficulté. Quand la concurrence, c’est-à-dire l’égoïsme, ne règnera plus dans la science, quand on s’associera pour étudier, au lieu d’envoyer aux Académies des paquets cachetés, on s’empressera de publier ses moindres observations pour peu qu’elles soient nouvelles et on ajoutera : « Je ne sais pas le reste. »

—Évariste Galois, Préface aux « Deux mémoires d’Analyse pure », décembre 1831