-
Notifications
You must be signed in to change notification settings - Fork 37
Available Modules: Custom inserted text #721
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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
)
@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 |
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/custom
and must match the name of the module exactly.For example:
mkdocs/docs/HPC/only/gent/available_software
custom/
(new)detail/
Where the content of
custom/Python.md
is:After running
scripts/available_software/available_software.py
, the contents ofdetail/Python.md
will beThis PR already adds
custom/
entries for AlphaFold, OpenFOAM, MATLAB and Python.Files in the
custom/
directory are excluded from search by mkdocs