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

31 lines
1.3 KiB
Rust

// Workspace: make
// File: make/src/lib.rs
//! The module `makepdf` is responsible for making a pdf using pdflatex.
//!
//! The main function, [`make_pdf`], orchestrates the entire process of preparing,
//! building, and cleaning up LaTeX files to produce a final PDF. It relies on several other modules
//! within the `makepdf` workspace to perform specific tasks.
//!
//! This module contains various helper functions used in the main build process.
//!
//! It provides utilities for checking and adding input lines based on specified conditions,
//! generating glossaries, and managing temporary files. These functions are essential for ensuring
//! that the LaTeX files are correctly prepared before invoking pdflatex to generate the final PDF.
//!
//! Contains utility data types used by other modules in the `makepdf` workspace.
//!
//! This module is responsible for defining the necessary data structures and traits that are shared
//! across different parts of the build process. It includes items such as enums, structs, and traits
//! that help in organizing and managing the various components involved in creating a PDF from LaTeX files.
//!
#![warn(missing_docs, clippy::missing_docs_in_private_items)]
// Internal modules
mod makepdf;
mod makepdf_functions;
mod makepdf_misc;
mod makepdf_structs;
// Re Export
pub use makepdf::make_pdf;