Configuration Struct

#include <configuration.h>

Public Members

std::string	file_name
std::vector<std::string>	defines
std::vector<std::string>	includes
std::vector<std::string>	includes_ext
std::vector<TopicInfo>	topics
std::string	readme
std::string	output
std::string	project_name
std::string	project_version
std::string	project_logo
std::string	license
std::string	license_display

Detailed Description

No description available.

Member Variable Documentation

std::string readme

The project's README source (path relative to build.source_path when the config sets one, else to the project config), copied into the version bundle as versions//README.md at build so the README travels with each version. Empty when the project declares no readme; the generator then emits nothing and the project page reports none available.

std::string license

The project's license source (path relative to build.source_path when the config sets one, else to the project config), the build.readme contract: copied into the version bundle as versions//LICENSE.md at build so each version keeps the license it shipped under. Empty when the manifest declares none; the generator then emits no license page. The SiteEngine inlines the bundled copy (version.license_md) at site-build.

std::string license_display

The license name for the "licensed under" line (e.g. "MIT"), from the project's "License" fact at build time.