Home#

rivt logo

rivt is an open source Python project for writing and sharing rivt files that publish formatted engineering documents (rivt docs) using the rivtlib package. A rivt doc is a text, HTML or PDF file published from a rivt file. A rivt file is a Python file (.py) that includes rivtlib and rivt markup.

rivtlib defines an API for rivt markup, which wraps and extends reStructuredText markup. It also organizes multiple docs into a report. This site is an example of an HTML report.

rivt integrates well with other open source programs. The recommended rivt framework is described here..

This is a small single doc example. This is a small report example. A search interface for discovering rivt files on GitHub is here.