Improve documentation generation scripts #814
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.
Contributor
Author
|
The UNIX documentation generation script has just been updated to only check for the Darwin kernel used in macOS, and assume every other platform as Linux, considering Linux-compatible platforms such as FreeBSD and custom kernels. |
Member
|
I'm not too knowledgable to even touch the documentation scripts, so i'm requesting a review who does |
Member
|
Please anyone? |
Contributor
|
3 at the same time lol. |
Contributor
|
@NexIsDumb sorry for the disturb, do you know anything about the documentation script or no? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request improves the automation of documentation generation.
From the initial commit's message:
The filenames of the scripts now follow snake-case and follow a similar naming convention to the library installation scripts. Do note that Lime is also invoked through Haxelib for compatibility reasons (particularly with NixOS), but it should work the same and maybe even somewhat faster.