xmake-gendoc/doc/en-us/pages.lua

{
    name = "English",
    flag = "🇬🇧",
    categories = {
        {
            title = "Introduction",
            pages = {
                {
                    docdir = ".",
                    title = "index",
                },
            },
        },
        {
            title = "Description Scope",
            pages = {
                {
                    docdir = "api/description/builtins",
                    title = "Global",
                },
                {
                    docdir = "api/description/scopes/target",
                    title = "Target",
                },
                {
                    docdir = "api/description/scopes/package",
                    title = "Package",
                },
                {
                    docdir = "api/description/scopes/option",
                    title = "Option",
                },
                {
                    docdir = "api/description/scopes/rule",
                    title = "Rule",
                },
                {
                    docdir = "api/description/scopes/toolchain",
                    title = "Toolchain",
                },
                {
                    docdir = "api/description/builtin_variables",
                    title = "Built-in variables",
                },
                {
                    docdir = "api/description/conditions",
                    title = "Conditions",
                },
            },
        },
        {
            title = "Description Scope Modules",
            pages = {
                {
                    docdir = "api/description/builtin_modules/linuxos",
                    title = "linuxos",
                },
                {
                    docdir = "api/description/builtin_modules/macos",
                    title = "macos",
                },
                {
                    docdir = "api/description/builtin_modules/math",
                    title = "math",
                },
                {
                    docdir = "api/description/builtin_modules/os",
                    title = "os",
                },
                {
                    docdir = "api/description/builtin_modules/path",
                    title = "path",
                },
                {
                    docdir = "api/description/builtin_modules/string",
                    title = "string",
                },
                {
                    docdir = "api/description/builtin_modules/table",
                    title = "table",
                },
                {
                    docdir = "api/description/builtin_modules/winos",
                    title = "winos",
                },
                {
                    docdir = "api/description/builtin_modules/xmake",
                    title = "xmake",
                },
            },
        },
        {
            title = "Scripting API",
            pages = {
                {
                    docdir = "api/script/builtins",
                    title = "Built-in functions",
                },
                {
                    docdir = "api/script/instances/target",
                    title = "Target instance API",
                },
                {
                    docdir = "api/script/instances/package",
                    title = "Package instance API",
                },
                {
                    docdir = "api/script/instances/option",
                    title = "Option instance API",
                },
                {
                    docdir = "api/script/instances/rule",
                    title = "Rule instance API",
                },
                {
                    docdir = "api/script/instances/toolchain",
                    title = "Toolchain instance API",
                },
            },
        },
        {
            title = "Scripting Modules API",
            pages = {
                {
                    docdir = "api/script/builtin_modules/coroutine",
                    title = "coroutine",
                },
                {
                    docdir = "api/script/builtin_modules/debug",
                    title = "debug",
                },
                {
                    docdir = "api/script/builtin_modules/hash",
                    title = "hash",
                },
                {
                    docdir = "api/script/builtin_modules/io",
                    title = "io",
                },
                {
                    docdir = "api/script/builtin_modules/linuxos",
                    title = "linuxos",
                },
                {
                    docdir = "api/script/builtin_modules/macos",
                    title = "macos",
                },
                {
                    docdir = "api/script/builtin_modules/math",
                    title = "math",
                },
                {
                    docdir = "api/script/builtin_modules/os",
                    title = "os",
                },
                {
                    docdir = "api/script/builtin_modules/path",
                    title = "path",
                },
                {
                    docdir = "api/script/builtin_modules/string",
                    title = "string",
                },
                {
                    docdir = "api/script/builtin_modules/table",
                    title = "table",
                },
                {
                    docdir = "api/script/builtin_modules/utils",
                    title = "utils",
                },
                {
                    docdir = "api/script/builtin_modules/winos",
                    title = "winos",
                },
                {
                    docdir = "api/script/builtin_modules/xmake",
                    title = "xmake",
                },
            },
        },
        {
            title = "Scripting Extension Modules API",
            pages = {
                {
                    docdir = "api/script/extension_modules/async",
                    title = "async",
                },
                {
                    docdir = "api/script/extension_modules/cli",
                    title = "cli",
                },
                {
                    docdir = "api/script/extension_modules/core/base",
                    title = "core.base",
                },
                {
                    docdir = "api/script/extension_modules/core/base/base64",
                    title = "core.base.base64",
                },
                {
                    docdir = "api/script/extension_modules/core/base/bit",
                    title = "core.base.bit",
                },
                {
                    docdir = "api/script/extension_modules/core/base/bloom_filter",
                    title = "core.base.bloom_filter",
                },
                {
                    docdir = "api/script/extension_modules/core/base/cli",
                    title = "core.base.cli",
                },
                {
                    docdir = "api/script/extension_modules/core/base/colors",
                    title = "core.base.colors",
                },
                {
                    docdir = "api/script/extension_modules/core/base/cpu",
                    title = "core.base.cpu",
                },
                {
                    docdir = "api/script/extension_modules/core/base/filter",
                    title = "core.base.filter",
                },
                {
                    docdir = "api/script/extension_modules/core/base/fwatcher",
                    title = "core.base.fwatcher",
                },
                {
                    docdir = "api/script/extension_modules/core/base/global",
                    title = "core.base.global",
                },
                {
                    docdir = "api/script/extension_modules/core/base/hashset",
                    title = "core.base.hashset",
                },
                {
                    docdir = "api/script/extension_modules/core/base/heap",
                    title = "core.base.heap",
                },
                {
                    docdir = "api/script/extension_modules/core/base/interpreter",
                    title = "core.base.interpreter",
                },
                {
                    docdir = "api/script/extension_modules/core/base/json",
                    title = "core.base.json",
                },
                {
                    docdir = "api/script/extension_modules/core/base/libc",
                    title = "core.base.libc",
                },
                {
                    docdir = "api/script/extension_modules/core/base/license",
                    title = "core.base.license",
                },
                {
                    docdir = "api/script/extension_modules/core/base/memory",
                    title = "core.base.memory",
                },
                {
                    docdir = "api/script/extension_modules/core/base/option",
                    title = "core.base.option",
                },
                {
                    docdir = "api/script/extension_modules/core/base/pipe",
                    title = "core.base.pipe",
                },
                {
                    docdir = "api/script/extension_modules/core/base/privilege",
                    title = "core.base.privilege",
                },
                {
                    docdir = "api/script/extension_modules/core/base/process",
                    title = "core.base.process",
                },
                {
                    docdir = "api/script/extension_modules/core/base/profiler",
                    title = "core.base.profiler",
                },
                {
                    docdir = "api/script/extension_modules/core/base/scheduler",
                    title = "core.base.scheduler",
                },
                {
                    docdir = "api/script/extension_modules/core/base/semver",
                    title = "core.base.semver",
                },
                {
                    docdir = "api/script/extension_modules/core/base/signal",
                    title = "core.base.signal",
                },
                {
                    docdir = "api/script/extension_modules/core/base/singleton",
                    title = "core.base.singleton",
                },
                {
                    docdir = "api/script/extension_modules/core/base/socket",
                    title = "core.base.socket",
                },
                {
                    docdir = "api/script/extension_modules/core/base/task",
                    title = "core.base.task",
                },
                {
                    docdir = "api/script/extension_modules/core/base/text",
                    title = "core.base.text",
                },
                {
                    docdir = "api/script/extension_modules/core/base/tty",
                    title = "core.base.tty",
                },
                {
                    docdir = "api/script/extension_modules/core/cache/detectcache",
                    title = "core.cache.detectcache",
                },
                {
                    docdir = "api/script/extension_modules/core/cache/global_detectcache",
                    title = "core.cache.global_detectcache",
                },
                {
                    docdir = "api/script/extension_modules/core/cache/globalcache",
                    title = "core.cache.globalcache",
                },
                {
                    docdir = "api/script/extension_modules/core/cache/localcache",
                    title = "core.cache.localcache",
                },
                {
                    docdir = "api/script/extension_modules/core/cache/memcache",
                    title = "core.cache.memcache",
                },
                {
                    docdir = "api/script/extension_modules/core/compress/lz4",
                    title = "core.compress.lz4",
                },
                {
                    docdir = "api/script/extension_modules/core/language/language",
                    title = "core.language.language",
                },
                {
                    docdir = "api/script/extension_modules/core/language/menu",
                    title = "core.language.menu",
                },
                {
                    docdir = "api/script/extension_modules/core/package/package",
                    title = "core.package.package",
                },
                {
                    docdir = "api/script/extension_modules/core/package/repository",
                    title = "core.package.repository",
                },
                {
                    docdir = "api/script/extension_modules/core/platform/menu",
                    title = "core.platform.menu",
                },
                {
                    docdir = "api/script/extension_modules/core/platform/platform",
                    title = "core.platform.platform",
                },
                {
                    docdir = "api/script/extension_modules/core/project/config",
                    title = "core.project.config",
                },
                {
                    docdir = "api/script/extension_modules/core/project/depend",
                    title = "core.project.depend",
                },
                {
                    docdir = "api/script/extension_modules/core/project/menu",
                    title = "core.project.menu",
                },
                {
                    docdir = "api/script/extension_modules/core/project/option",
                    title = "core.project.option",
                },
                {
                    docdir = "api/script/extension_modules/core/project/policy",
                    title = "core.project.policy",
                },
                {
                    docdir = "api/script/extension_modules/core/project/project",
                    title = "core.project.project",
                },
                {
                    docdir = "api/script/extension_modules/core/project/rule",
                    title = "core.project.rule",
                },
                {
                    docdir = "api/script/extension_modules/core/project/target",
                    title = "core.project.target",
                },
                {
                    docdir = "api/script/extension_modules/core/project/task",
                    title = "core.project.task",
                },
                {
                    docdir = "api/script/extension_modules/core/project/template",
                    title = "core.project.template",
                },
                {
                    docdir = "api/script/extension_modules/core/sandbox/module",
                    title = "core.sandbox.module",
                },
                {
                    docdir = "api/script/extension_modules/core/sandbox/sandbox",
                    title = "core.sandbox.sandbox",
                },
                {
                    docdir = "api/script/extension_modules/core/theme/theme",
                    title = "core.theme.theme",
                },
                {
                    docdir = "api/script/extension_modules/core/tool/compiler",
                    title = "core.tool.compiler",
                },
                {
                    docdir = "api/script/extension_modules/core/tool/linker",
                    title = "core.tool.linker",
                },
                {
                    docdir = "api/script/extension_modules/core/tool/toolchain",
                    title = "core.tool.toolchain",
                },
                {
                    docdir = "api/script/extension_modules/core/ui",
                    title = "core.ui",
                },
                {
                    docdir = "api/script/extension_modules/core/ui/curses",
                    title = "core.ui.curses",
                },
                {
                    docdir = "api/script/extension_modules/core/ui/log",
                    title = "core.ui.log",
                },
                {
                    docdir = "api/script/extension_modules/detect/packages",
                    title = "detect.packages",
                },
                {
                    docdir = "api/script/extension_modules/detect/sdks",
                    title = "detect.sdks",
                },
                {
                    docdir = "api/script/extension_modules/detect/sdks/matlab",
                    title = "detect.sdks.matlab",
                },
                {
                    docdir = "api/script/extension_modules/devel/debugger",
                    title = "devel.debugger",
                },
                {
                    docdir = "api/script/extension_modules/devel/git",
                    title = "devel.git",
                },
                {
                    docdir = "api/script/extension_modules/devel/git/submodule",
                    title = "devel.git.submodule",
                },
                {
                    docdir = "api/script/extension_modules/lib/detect",
                    title = "lib.detect",
                },
                {
                    docdir = "api/script/extension_modules/lib/detect/pkgconfig",
                    title = "lib.detect.pkgconfig",
                },
                {
                    docdir = "api/script/extension_modules/net",
                    title = "net",
                },
                {
                    docdir = "api/script/extension_modules/net/fasturl",
                    title = "net.fasturl",
                },
                {
                    docdir = "api/script/extension_modules/net/http",
                    title = "net.http",
                },
                {
                    docdir = "api/script/extension_modules/net/proxy",
                    title = "net.proxy",
                },
                {
                    docdir = "api/script/extension_modules/os/winver",
                    title = "os.winver",
                },
                {
                    docdir = "api/script/extension_modules/package/manager",
                    title = "package.manager",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/apt",
                    title = "package.manager.apt",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/brew",
                    title = "package.manager.brew",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/cargo",
                    title = "package.manager.cargo",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/clib",
                    title = "package.manager.clib",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/cmake",
                    title = "package.manager.cmake",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/conan",
                    title = "package.manager.conan",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/conan/v1",
                    title = "package.manager.conan.v1",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/conan/v2",
                    title = "package.manager.conan.v2",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/conda",
                    title = "package.manager.conda",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/dub",
                    title = "package.manager.dub",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/go",
                    title = "package.manager.go",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/nimble",
                    title = "package.manager.nimble",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/pacman",
                    title = "package.manager.pacman",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/pkgconfig",
                    title = "package.manager.pkgconfig",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/portage",
                    title = "package.manager.portage",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/system",
                    title = "package.manager.system",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/vcpkg",
                    title = "package.manager.vcpkg",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/xmake",
                    title = "package.manager.xmake",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/yum",
                    title = "package.manager.yum",
                },
                {
                    docdir = "api/script/extension_modules/package/manager/zypper",
                    title = "package.manager.zypper",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/autoconf",
                    title = "package.tools.autoconf",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/bazel",
                    title = "package.tools.bazel",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/cmake",
                    title = "package.tools.cmake",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/gn",
                    title = "package.tools.gn",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/make",
                    title = "package.tools.make",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/meson",
                    title = "package.tools.meson",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/msbuild",
                    title = "package.tools.msbuild",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/ninja",
                    title = "package.tools.ninja",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/nmake",
                    title = "package.tools.nmake",
                },
                {
                    docdir = "api/script/extension_modules/package/tools/scons",
                    title = "package.tools.scons",
                },
                {
                    docdir = "api/script/extension_modules/privilege/sudo",
                    title = "privilege.sudo",
                },
                {
                    docdir = "api/script/extension_modules/target/action",
                    title = "target.action",
                },
                {
                    docdir = "api/script/extension_modules/target/action/install",
                    title = "target.action.install",
                },
                {
                    docdir = "api/script/extension_modules/target/action/install/unix",
                    title = "target.action.install.unix",
                },
                {
                    docdir = "api/script/extension_modules/target/action/install/windows",
                    title = "target.action.install.windows",
                },
                {
                    docdir = "api/script/extension_modules/target/action/uninstall/unix",
                    title = "target.action.uninstall.unix",
                },
                {
                    docdir = "api/script/extension_modules/target/action/uninstall/windows",
                    title = "target.action.uninstall.windows",
                },
                {
                    docdir = "api/script/extension_modules/ui/app",
                    title = "ui.app",
                },
                {
                    docdir = "api/script/extension_modules/utils/archive",
                    title = "utils.archive",
                },
                {
                    docdir = "api/script/extension_modules/utils/ci",
                    title = "utils.ci",
                },
                {
                    docdir = "api/script/extension_modules/utils/ipa",
                    title = "utils.ipa",
                },
                {
                    docdir = "api/script/extension_modules/utils/platform",
                    title = "utils.platform",
                },
                {
                    docdir = "api/script/extension_modules/utils/progress",
                    title = "utils.progress",
                },
                {
                    docdir = "api/script/extension_modules/utils/wdk",
                    title = "utils.wdk",
                },
            },
        },
    },
}