sidebars.js 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476
  1. module.exports = {
  2. docs: [
  3. {
  4. collapsed: true,
  5. type: 'category',
  6. label: 'Getting Started',
  7. items: [
  8. 'Home',
  9. 'What-Is-Premake',
  10. 'Using-Premake',
  11. 'Building-Premake'
  12. ]
  13. },
  14. {
  15. collapsed: true,
  16. type: 'category',
  17. label: 'Writing Premake Scripts',
  18. items: [
  19. 'Your-First-Script',
  20. 'Workspaces-and-Projects',
  21. 'Scopes-and-Inheritance',
  22. 'Adding-Source-Files',
  23. 'Linking',
  24. 'Configurations-and-Platforms',
  25. 'Filters',
  26. 'Build-Settings',
  27. 'Command-Line-Arguments',
  28. 'Using-Modules',
  29. 'Topics'
  30. ]
  31. },
  32. {
  33. collapsed: true,
  34. type: 'category',
  35. label: 'Extending Premake',
  36. items: [
  37. 'Extending-Premake',
  38. 'Code-Overview',
  39. 'Coding-Conventions',
  40. 'Overrides-and-Call-Arrays',
  41. 'Developing-Modules',
  42. 'Adding-New-Action'
  43. ]
  44. },
  45. {
  46. collapsed: true,
  47. type: 'category',
  48. label: 'Guides',
  49. items: [
  50. 'Sharing-Configuration-Settings'
  51. ]
  52. },
  53. {
  54. collapsed: true,
  55. type: 'category',
  56. label: 'Reference',
  57. items: [
  58. {
  59. collapsed: true,
  60. type: 'category',
  61. label: 'Project Settings',
  62. items: [
  63. 'androidapilevel',
  64. 'androidapplibname',
  65. 'architecture',
  66. 'assemblydebug',
  67. 'atl',
  68. 'basedir',
  69. 'bindirs',
  70. 'boundscheck',
  71. 'buildaction',
  72. 'buildcommands',
  73. 'buildcustomizations',
  74. 'builddependencies',
  75. 'buildinputs',
  76. 'buildlog',
  77. 'buildmessage',
  78. 'buildoptions',
  79. 'buildoutputs',
  80. 'buildrule',
  81. 'callingconvention',
  82. 'cdialect',
  83. 'characterset',
  84. 'checkaction',
  85. 'cleancommands',
  86. 'cleanextensions',
  87. 'clr',
  88. 'compilationmodel',
  89. 'compileas',
  90. 'compilebuildoutputs',
  91. 'computetargets',
  92. 'configfile',
  93. 'configmap',
  94. 'configuration',
  95. 'configurations',
  96. 'conformancemode',
  97. 'copylocal',
  98. 'cppdialect',
  99. 'csversion',
  100. 'customtoolnamespace',
  101. 'debug.prompt',
  102. 'debugargs',
  103. 'debugcommand',
  104. 'debugconnectcommands',
  105. 'debugconstants',
  106. 'debugdir',
  107. 'debugenvs',
  108. 'debugextendedprotocol',
  109. 'debugformat',
  110. 'debugger',
  111. 'debuggerflavor',
  112. 'debuggertype',
  113. 'debuglevel',
  114. 'debugpathmap',
  115. 'debugport',
  116. 'debugremotehost',
  117. 'debugsearchpaths',
  118. 'debugstartupcommands',
  119. 'debugtoolargs',
  120. 'debugtoolcommand',
  121. 'defaultplatform',
  122. 'defines',
  123. 'dependenciesfile',
  124. 'dependson',
  125. 'deploymentoptions',
  126. 'deprecatedfeatures',
  127. 'disablewarnings',
  128. 'display',
  129. 'docdir',
  130. 'docname',
  131. 'dofileopt',
  132. 'dotnetframework',
  133. 'dpiawareness',
  134. 'editandcontinue',
  135. 'editorintegration',
  136. 'embed',
  137. 'embedandsign',
  138. 'enabledefaultcompileitems',
  139. 'enablewarnings',
  140. 'endian',
  141. 'entrypoint',
  142. 'exceptionhandling',
  143. 'external',
  144. 'externalproject',
  145. 'externalrule',
  146. 'fastuptodate',
  147. 'fatalwarnings',
  148. 'fileextension',
  149. 'filename',
  150. 'files',
  151. 'filter',
  152. 'flags',
  153. 'floatabi',
  154. 'floatingpoint',
  155. 'floatingpointexceptions',
  156. 'forceincludes',
  157. 'forceusings',
  158. 'fpu',
  159. 'framework',
  160. 'frameworkdirs',
  161. 'functionlevellinking',
  162. 'gccprefix',
  163. 'group',
  164. 'headerdir',
  165. 'headername',
  166. 'icon',
  167. 'ignoredefaultlibraries',
  168. 'imageoptions',
  169. 'imagepath',
  170. 'implibdir',
  171. 'implibextension',
  172. 'implibname',
  173. 'implibprefix',
  174. 'implibsuffix',
  175. 'importdirs',
  176. 'includedirs',
  177. 'inlinesvisibility',
  178. 'inlining',
  179. 'intrinsics',
  180. 'iosfamily',
  181. 'isaextensions',
  182. 'jsonfile',
  183. 'justmycode',
  184. 'kind',
  185. 'language',
  186. 'largeaddressaware',
  187. 'libdirs',
  188. 'linkbuildoutputs',
  189. 'linkgroups',
  190. 'linkoptions',
  191. 'links',
  192. 'locale',
  193. 'location',
  194. 'makesettings',
  195. 'namespace',
  196. 'nativewchar',
  197. 'newaction',
  198. 'newoption',
  199. 'nuget',
  200. 'nugetsource',
  201. 'objdir',
  202. 'omitframepointer',
  203. 'openmp',
  204. 'optimize',
  205. 'pchheader',
  206. 'pchsource',
  207. 'pic',
  208. 'platforms',
  209. 'postbuildcommands',
  210. 'postbuildmessage',
  211. 'prebuildcommands',
  212. 'prebuildmessage',
  213. 'preferredtoolarchitecture',
  214. 'prelinkcommands',
  215. 'prelinkmessage',
  216. 'preview',
  217. 'project',
  218. 'propertydefinition',
  219. 'rebuildcommands',
  220. 'removeunreferencedcodedata',
  221. 'resdefines',
  222. 'resincludedirs',
  223. 'resoptions',
  224. 'resourcegenerator',
  225. 'revert',
  226. 'rtti',
  227. 'rule',
  228. 'rules',
  229. 'runpathdirs',
  230. 'runtime',
  231. 'shaderassembler',
  232. 'shaderassembleroutput',
  233. 'shaderdefines',
  234. 'shaderentry',
  235. 'shaderheaderfileoutput',
  236. 'shaderincludedirs',
  237. 'shadermodel',
  238. 'shaderobjectfileoutput',
  239. 'shaderoptions',
  240. 'shadertype',
  241. 'shadervariablename',
  242. 'sharedlibtype',
  243. 'startproject',
  244. 'staticruntime',
  245. 'stl',
  246. 'strictaliasing',
  247. 'stringimportdirs',
  248. 'stringpooling',
  249. 'structmemberalign',
  250. 'swiftversion',
  251. 'symbols',
  252. 'symbolspath',
  253. 'sysincludedirs',
  254. 'syslibdirs',
  255. 'system',
  256. 'systemversion',
  257. 'tags',
  258. 'tailcalls',
  259. 'targetdir',
  260. 'targetextension',
  261. 'targetname',
  262. 'targetprefix',
  263. 'targetsuffix',
  264. 'thumbmode',
  265. 'toolchainversion',
  266. 'toolset',
  267. 'toolsversion',
  268. 'transition',
  269. 'undefines',
  270. 'unsignedchar',
  271. 'usefullpaths',
  272. 'usingdirs',
  273. 'uuid',
  274. 'vectorextensions',
  275. 'versionconstants',
  276. 'versionlevel',
  277. 'visibility',
  278. 'vpaths',
  279. 'warnings',
  280. 'workspace',
  281. 'xcodebuildresources',
  282. 'xcodebuildsettings',
  283. 'xcodecodesigningidentity',
  284. 'xcodesystemcapabilities'
  285. ]
  286. },
  287. {
  288. collapsed: true,
  289. type: 'category',
  290. label: 'Globals',
  291. items: [
  292. '_ACTION',
  293. '_ARGS',
  294. '_MAIN_SCRIPT_DIR',
  295. '_MAIN_SCRIPT',
  296. '_OPTIONS',
  297. '_OS',
  298. '_PREMAKE_COMMAND',
  299. '_PREMAKE_DIR',
  300. '_PREMAKE_VERSION',
  301. '_WORKING_DIR',
  302. 'iif',
  303. 'include',
  304. 'includeexternal',
  305. 'printf',
  306. 'require',
  307. 'verbosef',
  308. ]
  309. },
  310. {
  311. collapsed: true,
  312. type: 'category',
  313. label: 'http',
  314. items: [
  315. 'http.download',
  316. 'http.get',
  317. 'http.post',
  318. 'http-options-table'
  319. ]
  320. },
  321. {
  322. collapsed: true,
  323. type: 'category',
  324. label: 'io',
  325. items: [
  326. 'io.readfile',
  327. 'io.utf8',
  328. 'io.writefile'
  329. ]
  330. },
  331. {
  332. collapsed: true,
  333. type: 'category',
  334. label: 'json',
  335. items: [
  336. 'json.decode',
  337. 'json.encode'
  338. ]
  339. },
  340. {
  341. collapsed: true,
  342. type: 'category',
  343. label: 'os',
  344. items: [
  345. 'os.chdir',
  346. 'os.chmod',
  347. 'os.comparefiles',
  348. 'os.copyfile',
  349. 'os.execute',
  350. 'os.executef',
  351. 'os.findheader',
  352. 'os.findlib',
  353. 'os.get',
  354. 'os.getcwd',
  355. 'os.getpass',
  356. 'os.getversion',
  357. 'os.host',
  358. 'os.is',
  359. 'os.is64bit',
  360. 'os.isdir',
  361. 'os.isfile',
  362. 'os.islink',
  363. 'os.locate',
  364. 'os.matchdirs',
  365. 'os.matchfiles',
  366. 'os.mkdir',
  367. 'os.outputof',
  368. 'os.pathsearch',
  369. 'os.realpath',
  370. 'os.remove',
  371. 'os.rmdir',
  372. 'os.stat',
  373. 'os.target',
  374. 'os.touchfile',
  375. 'os.translateCommands',
  376. 'os.uuid',
  377. 'os.writefile_ifnotequal',
  378. ]
  379. },
  380. {
  381. collapsed: true,
  382. type: 'category',
  383. label: 'path',
  384. items: [
  385. 'path.appendExtension',
  386. 'path.getabsolute',
  387. 'path.getbasename',
  388. 'path.getdirectory',
  389. 'path.getdrive',
  390. 'path.getextension',
  391. 'path.getname',
  392. 'path.getrelative',
  393. 'path.hasextension',
  394. 'path.isabsolute',
  395. 'path.iscfile',
  396. 'path.iscppfile',
  397. 'path.iscppheader',
  398. 'path.isframework',
  399. 'path.islinkable',
  400. 'path.isobjectfile',
  401. 'path.isresourcefile',
  402. 'path.join',
  403. 'path.normalize',
  404. 'path.rebase',
  405. 'path.replaceextension',
  406. 'path.translate',
  407. 'path.wildcards',
  408. ]
  409. },
  410. {
  411. collapsed: true,
  412. type: 'category',
  413. label: 'string',
  414. items: [
  415. 'string.capitalized',
  416. 'string.contains',
  417. 'string.endswith',
  418. 'string.escapepattern',
  419. 'string.explode',
  420. 'string.findlast',
  421. 'string.hash',
  422. 'string.lines',
  423. 'string.plural',
  424. 'string.sha1',
  425. 'string.startswith'
  426. ]
  427. },
  428. {
  429. collapsed: true,
  430. type: 'category',
  431. label: 'table',
  432. items: [
  433. 'table.arraycopy',
  434. 'table.contains',
  435. 'table.deepcopy',
  436. 'table.extract',
  437. 'table.filterempty',
  438. 'table.flatten',
  439. 'table.fold',
  440. 'table.foreachi',
  441. 'table.implode',
  442. 'table.indexof',
  443. 'table.insertafter',
  444. 'table.insertflat',
  445. 'table.isempty',
  446. 'table.join',
  447. 'table.keys',
  448. 'table.merge',
  449. 'table.replace',
  450. 'table.tostring',
  451. 'table.translate',
  452. ]
  453. },
  454. {
  455. collapsed: true,
  456. type: 'category',
  457. label: 'term',
  458. items: [
  459. 'term.getTextColor',
  460. 'term.popColor',
  461. 'term.pushColor',
  462. 'term.setTextColor'
  463. ]
  464. },
  465. {
  466. collapsed: true,
  467. type: 'category',
  468. label: 'zip',
  469. items: [
  470. 'zip.extract'
  471. ]
  472. }
  473. ],
  474. }
  475. ],
  476. };