Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Fluss Documentation Generator

This module contains utilities to automatically generate documentation parts from the Fluss source code. This ensures that the documentation stays in sync with the actual implementation and default values.

Configuration Options Generator

The ConfigOptionsDocGenerator scans the ConfigOptions class and generates an MDX partial file containing categorized tables of all available configuration settings.

How it works

  1. It uses reflection to find all ConfigOption fields in the ConfigOptions class.
  2. It groups options into sections based on the @ConfigSection annotation or key prefixes.
  3. It handles special default value formatting via @ConfigOverrideDefault.
  4. It outputs an MDX partial file (_partial_config.mdx) to the website/docs/_configs/ directory for direct import into the Docusaurus site.

Running the Generator

To update the configuration documentation, run the following command from the project root:

./mvnw compile -pl fluss-docgen -am

Integration with Website

The generated file is stored in website/docs/_configs/_partial_config.mdx. To display these tables in the documentation, use the MDX import syntax in any .md or .mdx file:

import PartialConfig from '../_configs/_partial_config.mdx'; <PartialConfig></PartialConfig>