Plugins¶

  • Mandatory plugins
  • Action plugins
    • action.autocommand — Compile file according to mime type or extension
    • action.command — Explicitly set the command to compile a file
    • action.make — Compile file using a Makefile
    • action.raw — Do not compile file: use file as-is
    • Which plugin applies to which file?
    • Options
  • Misc plugins
    • copy — Copy files at the end of compilation
    • debug.hooks — Print hook calls
  • Logging plugins
    • logging.quiet — Does not log anything
    • logging.stdlib — Use the Python logging module
    • logging.auto — Automatic plugin selection
    • logging.rich — Logging with colors and progress bar
  • Renderer plugins
    • renderer.jinja2 — jinja2 renderer
    • renderer.html — HTML renderer
    • renderer.htmlplus — HTML renderer, with a bit of CSS and javascript
    • renderer.text — Text renderer
  • VCS plugins
    • vcs.fs — Process any file of the file system
    • vcs.git — Only process files handled by git
    • vcs.none — Do not process any file
  • Write your own plugin
    • Minimum example
    • Attributes
    • Current working directory
    • Interacting with Évariste

Plugin paths¶

Évariste looks fro new plugins (as python packages) in the following directories (this is relevant when writing or installing new plugins):

  • .evariste/plugins/foo.py (relative to the directory of the setup file);

  • ~/.local/evariste/plugins/foo.py

  • ~/.evariste/plugins/foo.py

  • LIBDIR/foo.py (where LIBDIR is any directory of the libdirs setup option).

Évariste

Navigation

  • Use case
  • Download and install
  • User documentation
  • Plugins
    • Mandatory plugins
    • Action plugins
    • Misc plugins
    • Logging plugins
    • Renderer plugins
    • VCS plugins
    • Write your own plugin
    • Plugin paths
  • evs tools
  • Library documentation

Related Topics

  • Documentation overview
    • Previous: Source
    • Next: Mandatory plugins
©2015-2026, Louis Paternault. | Powered by Sphinx 9.1.0 & Alabaster 1.0.0 | Page source