Skip to content

Latest commit

 

History

History

fml-docs-generator

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

/fml-docs-generator

A utility to auto-generate parts of the user documentation:

  1. Reads and parses FmlYy for functions etc.
  2. Generates documentation for the functions into /docs (API Reference)

The batch file run_docs_generator.bat at the root of the repo can be used to easily compile and run this tool with the appropriate command line arguments etc.

A lot of configurations, file paths etc. are hard coded into the source code of this program. Consider this a script tailored for this exact project rather than a general purpose program.

This is a Rust program built with Cargo.