Fix make vars and improve docs gen #123
Open
+23
−13
Conversation
This file contains 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
amc-corey-cox
requested review from
sujaypatil96,
sierra-moxon and
pkalita-lbl
|
I chose all of you because you appear to have a hand in driving the direction of the cookie-cutter but if there is someone more appropriate for this code review please let me know. |
|
Sorry I haven't taken a look at this yet, will have it reviewed by early next week @amc-corey-cox. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I've removed the quoting from the variables file sourced by Makefile. This fixes some of the strange errors that occur when the variables are used that result in partial quotations on execution.
I have also moved around the doc gen files and added a templates folder with a README.md, explaining where to get the default templates for modification. I also nested the files used for docgen under docs/files instead of just docs/ so that all of the doc gen stuff can live together there.
Finally, I renamed the .env.public file to config.public.mk to reflect the fact that it is a configuration file for Makefile. This seems to be consistent with some conventions in the Makefile community and helps to differentiate it from an environment file that follows different conventions.
Please give me any feedback you have on these rearrangements. I'm happy to make changes to accommodate how we want to do things in the LinkML community. These were just what made sense to me.