Available Modules: Custom inserted text#721
Open
lbarraga wants to merge 19 commits intohpcugent:mainfrom
Open
Conversation
boegel
requested changes
Sep 19, 2024
Member
boegel
left a comment
There was a problem hiding this comment.
@lbarraga Please also add some basic instructions in scripts/available_software/README on how custom bits of text can be injected in the software-specific pages
Alos, add mkdocs/docs/HPC/only/gent/available_software/README.md which explains which files are auto-generated, and which ones are not (custom/*.md)
Member
|
@lbarraga A next step could be to auto-detect that there's a matching "software-specific best practices page" This would involve:
Let's make that a separate PR, this one can be merged once missing |
Co-authored-by: Kenneth Hoste <kenneth.hoste@ugent.be>
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
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.
This PR add a feature where custom MarkDown can be inserted into the available software MarkDown files.
The custom text files will be located at
mkdocs/docs/HPC/only/gent/available_software/customand must match the name of the module exactly.For example:
mkdocs/docs/HPC/only/gent/available_softwarecustom/(new)detail/Where the content of
custom/Python.mdis:After running
scripts/available_software/available_software.py, the contents ofdetail/Python.mdwill beThis PR already adds
custom/entries for AlphaFold, OpenFOAM, MATLAB and Python.Files in the
custom/directory are excluded from search by mkdocs