ravenous-tools/crates/tablegen/src/lib.rs

30 lines
1.3 KiB
Rust

// Workspace: tablegen
// File: tablegen/src/lib.rs
//! This is a library for generating LaTeX tables from TSV files.
//!
//! The main entry point of this library is the `table_gen` function, which takes in configuration arguments and a config object,
//! then processes the specified files according to their type (classes, craft, etc.).
//! If an error occurs during processing, it will be reported via a Result.
//!
//! This library consists of several modules:
//!
//! - `table_structs`: Defines the structure and behavior of tables. It includes types like `RecordClass` representing
//! a class record in a TSV file and `ClassesArray` holding all the data for classes.
//! - `table_types`: Contains types related to TSV files and LaTeX code generation.
//! It provides structures like `GenericArray` for creating tables based on generic records,
//! and utility types like `CleanString` for handling string formatting specific to LaTeX tables.
//! - `tablegen`: Contatining the whole logic behind the table generation
//!
//! The following functions are re-exported from the module `tablegen`:
//!
//! - [`table_gen`]: Handling the whole conversion and auto dispatch.
#![warn(missing_docs, clippy::missing_docs_in_private_items)]
mod table_structs;
mod table_types;
mod tablegen;
use cli_parser::Config;
// Reexport
pub use tablegen::table_gen;