mirror of
https://github.com/AdaCore/gpr.git
synced 2026-02-12 12:58:39 -08:00
70 lines
2.9 KiB
Python
70 lines
2.9 KiB
Python
#!/usr/bin/env python3
|
|
|
|
import logging
|
|
|
|
# Substring to escape on Attributes description for sphinx format compliance
|
|
substrings_to_escape = ["*"]
|
|
|
|
# Translation into text from an attribute key and value
|
|
attribute_key_value_translation = {
|
|
("index_type", "NO_INDEX"): "",
|
|
("index_type", "UNIT_INDEX"): "indexed by a unit",
|
|
("index_type", "ENV_VAR_NAME_INDEX"): "indexed by an external reference",
|
|
("index_type", "FILE_INDEX"): "indexed by a file name",
|
|
("index_type", "FILEGLOB_INDEX"): "indexed by a source glob",
|
|
("index_type", "LANGUAGE_INDEX"): "indexed by a language",
|
|
("index_type", "FILEGLOB_OR_LANGUAGE_INDEX"): "indexed by a source glob or language",
|
|
("index_optional", True): '"others" index allowed',
|
|
("index_optional", False): "",
|
|
("value", "SINGLE"): "single value",
|
|
("value", "LIST"): "list value",
|
|
("value", "SET"): "set value",
|
|
("value_case_sensitive", True): "case-sensitive",
|
|
("value_case_sensitive", False): "case-insensitive",
|
|
("value_is_set", True): "",
|
|
("value_is_set", False): "",
|
|
("empty_value", "ALLOW"): "",
|
|
("empty_value", "IGNORE"): "",
|
|
("empty_value", "ERROR"): "",
|
|
("builtin", True): "read-only",
|
|
("builtin", False): "",
|
|
("is_allowed_in"): "",
|
|
("has_default_in"): "",
|
|
("default"): "",
|
|
("is_toolchain_config", True): "",
|
|
("is_toolchain_config", False): "",
|
|
("config_concatenable", True): "configuration concatenable",
|
|
("config_concatenable", False): "",
|
|
("inherit_from_extended", "INHERITED"): "",
|
|
("inherit_from_extended", "CONCATENATED"): "concatenated with extended value",
|
|
("inherit_from_extended", "NOT_INHERITED"): "not inherited from extended project",
|
|
}
|
|
|
|
attributes_warnings = {
|
|
"Linker.Default_Switches": 'Index "others" is not supported yet in gprbuild or GNATcoll.Projects-based tools',
|
|
"Naming.Specification_Suffix" : 'Also has case-insensitive values in gprbuild and GNATcoll.Project-based tools',
|
|
"Naming.Spec_Suffix" : 'Also has case-insensitive values in gprbuild and GNATcoll.Project-based tools',
|
|
"Naming.Implementation_Suffix" : 'Also has case-insensitive values in gprbuild and GNATcoll.Project-based tools',
|
|
"Naming.Body_Suffix" : 'Also has case-insensitive values in gprbuild and GNATcoll.Project-based tools',
|
|
"Project_Level.Archive_Builder": 'Empty value is not supported yet in non GNATcoll.Project-based tools'
|
|
}
|
|
|
|
attribute_additionnal_ref = {
|
|
"Project_Level.Library_Version": "For more details see the :ref:`attribute semantics <Library_Version>`."
|
|
}
|
|
|
|
# Complementary files
|
|
complementary_files = {
|
|
"Intro_File": "./__python__/metadata/attributes_introduction.rst",
|
|
"Config_File": "./__python__/metadata/attributes_category.json",
|
|
}
|
|
|
|
# General configuration of the documentation generation
|
|
display_options = {"Max_Length": 80, "Short_Def": True, "Whole_Def": False}
|
|
|
|
# Logging configuration
|
|
logging_options = {
|
|
"Level": logging.INFO,
|
|
"Format": "[%(levelname)s] - %(message)s",
|
|
}
|