cde7d46572
* Improve documentation generation scripts There is now a UNIX documentation generation script in the form of a shell script. The Windows shell script has also been improved, and some of the output of that script has been improved to match the UNIX one. Because the scripts still use Lime to generate the documentation, the shell script checks the kernel name using uname, and change the documentation generation command ever so slightly. The reason for this is that Lime only supports building to one platform at a time. This makes manual intervention necessary, so the UNIX script checks for the kernel ahead of time. * Allow Linux-compatible kernels to work with UNIX doc generation script Considering the variety of kernels available alongside ELF compatibility, the UNIX documentation generation script has been modified to only check for the Darwin kernel and assume every other kernel as Linux-compatible. * Small consistency change in UNIX doc script when echoing pre-check message * moving and small change * cooler readme + docs generation guide --------- Co-authored-by: ⍚~Nex <87421482+NexIsDumb@users.noreply.github.com>
9 lines
425 B
Batchfile
9 lines
425 B
Batchfile
@ECHO OFF
|
|
cd /d "%~dp0.."
|
|
echo Generating documentation...
|
|
echo Platform is based on Windows
|
|
haxelib run lime build windows --haxeflag="-xml docs/doc.xml" -D doc-gen -D DOCUMENTATION --no-output
|
|
|
|
echo The XML file for the API documentation has been generated at docs/doc.xml.
|
|
echo For updating the API documentation hosted at the website, please replace codename-website/api-generator/api/doc.xml with the file listed above.
|