From f44531c6ecbff4b21b600b32ae149817ee696011 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Mon, 16 Sep 2024 16:16:51 +0200 Subject: [PATCH 01/18] custom text for available modules --- mkdocs/docs/HPC/module_custom_text/README.md | 0 .../docs/HPC/module_custom_text/openfoam.md | 5 +++ .../available_software/available_software.py | 35 +++++++++++++++++-- 3 files changed, 37 insertions(+), 3 deletions(-) create mode 100644 mkdocs/docs/HPC/module_custom_text/README.md create mode 100644 mkdocs/docs/HPC/module_custom_text/openfoam.md diff --git a/mkdocs/docs/HPC/module_custom_text/README.md b/mkdocs/docs/HPC/module_custom_text/README.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/mkdocs/docs/HPC/module_custom_text/openfoam.md b/mkdocs/docs/HPC/module_custom_text/openfoam.md new file mode 100644 index 000000000000..a184f7d43b0d --- /dev/null +++ b/mkdocs/docs/HPC/module_custom_text/openfoam.md @@ -0,0 +1,5 @@ +This is a test. + +```python +print("hallo") +``` \ No newline at end of file diff --git a/scripts/available_software/available_software.py b/scripts/available_software/available_software.py index 4df01adf639b..cd612ea556cd 100644 --- a/scripts/available_software/available_software.py +++ b/scripts/available_software/available_software.py @@ -78,8 +78,9 @@ def main(): print("Done!") print("Generate detailed pages... ", end="", flush=True) detail_folder = os.path.join(root_dir, "mkdocs/docs/HPC/only/gent/available_software/detail") + custom_text_folder = os.path.join(root_dir, "mkdocs/docs/HPC/module_custom_text") generated_time_yml = os.path.join(root_dir, "mkdocs/extra/gent.yml") # yml containing time the data was generated - generate_detail_pages(json_path, detail_folder, generated_time_yml) + generate_detail_pages(json_path, detail_folder, custom_text_folder, generated_time_yml) print("Done!") @@ -359,6 +360,7 @@ def generate_software_detail_page( software_name: str, software_data: dict, clusters: list, + custom_text_folder: str, path: str ) -> None: """ @@ -367,6 +369,7 @@ def generate_software_detail_page( @param software_name: Name of the software @param software_data: Additional information about the software (version, etc...) @param clusters: List with all the cluster names + @param custom_text_folder: Path to the folder with custom text for the software @param path: Path of the directory where the detailed page will be created. """ sorted_versions = dict_sort(software_data["versions"]) @@ -374,6 +377,9 @@ def generate_software_detail_page( filename = f"{path}/{software_name}.md" md_file = MdUtils(file_name=filename, title=f"{software_name}") + + md_file.write(get_custom_markdown_text(software_name, custom_text_folder)) + md_file.new_header(level=1, title="Available modules") md_file.new_paragraph(f"The overview below shows which {software_name} installations are available per HPC-UGent " @@ -399,7 +405,30 @@ def generate_software_detail_page( f.write("---\nhide:\n - toc\n---\n" + read_data) -def generate_detail_pages(json_path, dest_path, generated_time_yml) -> None: +def get_custom_markdown_text(module_name: str, custom_text_folder) -> str: + """ + Get the custom Markdown text that will be added to the detailed Markdown pages. + + @return: Custom Markdown text + """ + module_name_md = module_name + ".md" + module_name_md_lower = module_name.lower() + ".md" + + if os.path.exists(module_name_md_lower): + file_name = module_name_md_lower + + elif os.path.exists(module_name_md): + file_name = module_name_md + + else: + return "" + + custom_markdown_path = os.path.join(custom_text_folder, file_name) + with open(custom_markdown_path, 'r') as f: + return f.read() + + +def generate_detail_pages(json_path, dest_path, custom_text_folder, generated_time_yml) -> None: """ Generate all the detailed pages for all the software that is available. """ @@ -412,7 +441,7 @@ def generate_detail_pages(json_path, dest_path, generated_time_yml) -> None: all_clusters = data["clusters"] for software, content in data["software"].items(): - generate_software_detail_page(software, content, all_clusters, dest_path) + generate_software_detail_page(software, content, all_clusters, custom_text_folder, dest_path) def update_generated_time_yml(generated_time_yml, generated_time) -> None: From 15eeabf63b49dc13bd971d2b68a071a6f33a19a0 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Mon, 16 Sep 2024 16:45:56 +0200 Subject: [PATCH 02/18] custom markdown path not correct --- scripts/available_software/available_software.py | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/scripts/available_software/available_software.py b/scripts/available_software/available_software.py index cd612ea556cd..a87cd3d1eb83 100644 --- a/scripts/available_software/available_software.py +++ b/scripts/available_software/available_software.py @@ -405,25 +405,19 @@ def generate_software_detail_page( f.write("---\nhide:\n - toc\n---\n" + read_data) -def get_custom_markdown_text(module_name: str, custom_text_folder) -> str: +def get_custom_markdown_text(module_name: str, custom_text_folder: str) -> str: """ Get the custom Markdown text that will be added to the detailed Markdown pages. @return: Custom Markdown text """ - module_name_md = module_name + ".md" - module_name_md_lower = module_name.lower() + ".md" + custom_markdown_path = os.path.join(custom_text_folder, module_name + ".md") - if os.path.exists(module_name_md_lower): - file_name = module_name_md_lower - - elif os.path.exists(module_name_md): - file_name = module_name_md - - else: + if not os.path.exists(custom_markdown_path): return "" - custom_markdown_path = os.path.join(custom_text_folder, file_name) + print(f"Adding custom text for {module_name} located at {custom_markdown_path}") + with open(custom_markdown_path, 'r') as f: return f.read() From b396cf6fa1df05dfc6693812b607ebee4b9c7ab5 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Mon, 16 Sep 2024 17:04:48 +0200 Subject: [PATCH 03/18] correct OpenFOAM name + newline before --- mkdocs/docs/HPC/module_custom_text/OpenFOAM.md | 1 + mkdocs/docs/HPC/module_custom_text/openfoam.md | 5 ----- scripts/available_software/available_software.py | 1 + 3 files changed, 2 insertions(+), 5 deletions(-) create mode 100644 mkdocs/docs/HPC/module_custom_text/OpenFOAM.md delete mode 100644 mkdocs/docs/HPC/module_custom_text/openfoam.md diff --git a/mkdocs/docs/HPC/module_custom_text/OpenFOAM.md b/mkdocs/docs/HPC/module_custom_text/OpenFOAM.md new file mode 100644 index 000000000000..71fbdf4ac051 --- /dev/null +++ b/mkdocs/docs/HPC/module_custom_text/OpenFOAM.md @@ -0,0 +1 @@ +We also have a dedicated page on OpenFOAM available [here](../../../../../OpenFOAM.md). \ No newline at end of file diff --git a/mkdocs/docs/HPC/module_custom_text/openfoam.md b/mkdocs/docs/HPC/module_custom_text/openfoam.md deleted file mode 100644 index a184f7d43b0d..000000000000 --- a/mkdocs/docs/HPC/module_custom_text/openfoam.md +++ /dev/null @@ -1,5 +0,0 @@ -This is a test. - -```python -print("hallo") -``` \ No newline at end of file diff --git a/scripts/available_software/available_software.py b/scripts/available_software/available_software.py index a87cd3d1eb83..14ea30321480 100644 --- a/scripts/available_software/available_software.py +++ b/scripts/available_software/available_software.py @@ -378,6 +378,7 @@ def generate_software_detail_page( filename = f"{path}/{software_name}.md" md_file = MdUtils(file_name=filename, title=f"{software_name}") + md_file.new_line() md_file.write(get_custom_markdown_text(software_name, custom_text_folder)) md_file.new_header(level=1, title="Available modules") From 9dbd047b2038b03e90c922f9527d3b3ad6d3e192 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 09:16:09 +0200 Subject: [PATCH 04/18] new file structure --- .../{ => gent/available_software/detail}/OpenFOAM.md | 2 +- .../docs/HPC/only/gent/available_software/detail/OpenFOAM.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) rename mkdocs/docs/HPC/module_custom_text/{ => gent/available_software/detail}/OpenFOAM.md (73%) diff --git a/mkdocs/docs/HPC/module_custom_text/OpenFOAM.md b/mkdocs/docs/HPC/module_custom_text/gent/available_software/detail/OpenFOAM.md similarity index 73% rename from mkdocs/docs/HPC/module_custom_text/OpenFOAM.md rename to mkdocs/docs/HPC/module_custom_text/gent/available_software/detail/OpenFOAM.md index 71fbdf4ac051..1ccb6911e58a 100644 --- a/mkdocs/docs/HPC/module_custom_text/OpenFOAM.md +++ b/mkdocs/docs/HPC/module_custom_text/gent/available_software/detail/OpenFOAM.md @@ -1 +1 @@ -We also have a dedicated page on OpenFOAM available [here](../../../../../OpenFOAM.md). \ No newline at end of file +We also have a dedicated page on OpenFOAM available [here](../../../../openFOAM.md). diff --git a/mkdocs/docs/HPC/only/gent/available_software/detail/OpenFOAM.md b/mkdocs/docs/HPC/only/gent/available_software/detail/OpenFOAM.md index b57d42de0b05..73acf70039f2 100644 --- a/mkdocs/docs/HPC/only/gent/available_software/detail/OpenFOAM.md +++ b/mkdocs/docs/HPC/only/gent/available_software/detail/OpenFOAM.md @@ -6,6 +6,9 @@ hide: OpenFOAM ======== +We also have a dedicated page on OpenFOAM available [here](../../../../openFOAM.md). + + # Available modules From 08fd06a60d05e88b49d76ab4f905f8319ca47739 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 10:13:18 +0200 Subject: [PATCH 05/18] move custo; markdown to available software folder + exclude from search --- config/templates/hpc.template | 1 + mkdocs/docs/HPC/module_custom_text/README.md | 0 .../detail => only/gent/available_software/custom}/OpenFOAM.md | 0 3 files changed, 1 insertion(+) delete mode 100644 mkdocs/docs/HPC/module_custom_text/README.md rename mkdocs/docs/HPC/{module_custom_text/gent/available_software/detail => only/gent/available_software/custom}/OpenFOAM.md (100%) diff --git a/config/templates/hpc.template b/config/templates/hpc.template index 30a3ba10ed8a..3691759c8941 100644 --- a/config/templates/hpc.template +++ b/config/templates/hpc.template @@ -90,6 +90,7 @@ plugins: - exclude-search: exclude: - content/HPC/* + - available_software/custom/* markdown_extensions: diff --git a/mkdocs/docs/HPC/module_custom_text/README.md b/mkdocs/docs/HPC/module_custom_text/README.md deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/mkdocs/docs/HPC/module_custom_text/gent/available_software/detail/OpenFOAM.md b/mkdocs/docs/HPC/only/gent/available_software/custom/OpenFOAM.md similarity index 100% rename from mkdocs/docs/HPC/module_custom_text/gent/available_software/detail/OpenFOAM.md rename to mkdocs/docs/HPC/only/gent/available_software/custom/OpenFOAM.md From 0a1a2c91194a5c1caea3fc8a409b31955a451728 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 10:34:29 +0200 Subject: [PATCH 06/18] add some software in custom dir --- .../docs/HPC/only/gent/available_software/custom/AlphaFold.md | 1 + mkdocs/docs/HPC/only/gent/available_software/custom/MATLAB.md | 1 + mkdocs/docs/HPC/only/gent/available_software/custom/OpenFOAM.md | 2 +- 3 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 mkdocs/docs/HPC/only/gent/available_software/custom/AlphaFold.md create mode 100644 mkdocs/docs/HPC/only/gent/available_software/custom/MATLAB.md diff --git a/mkdocs/docs/HPC/only/gent/available_software/custom/AlphaFold.md b/mkdocs/docs/HPC/only/gent/available_software/custom/AlphaFold.md new file mode 100644 index 000000000000..9bfc7122a14f --- /dev/null +++ b/mkdocs/docs/HPC/only/gent/available_software/custom/AlphaFold.md @@ -0,0 +1 @@ +We have a dedicated page on AlphaFold available [here](../../../../alphafold.md). \ No newline at end of file diff --git a/mkdocs/docs/HPC/only/gent/available_software/custom/MATLAB.md b/mkdocs/docs/HPC/only/gent/available_software/custom/MATLAB.md new file mode 100644 index 000000000000..a5435515c297 --- /dev/null +++ b/mkdocs/docs/HPC/only/gent/available_software/custom/MATLAB.md @@ -0,0 +1 @@ +We have a dedicated page on MATLAB available [here](../../../../MATLAB.md). \ No newline at end of file diff --git a/mkdocs/docs/HPC/only/gent/available_software/custom/OpenFOAM.md b/mkdocs/docs/HPC/only/gent/available_software/custom/OpenFOAM.md index 1ccb6911e58a..ef07e68b4415 100644 --- a/mkdocs/docs/HPC/only/gent/available_software/custom/OpenFOAM.md +++ b/mkdocs/docs/HPC/only/gent/available_software/custom/OpenFOAM.md @@ -1 +1 @@ -We also have a dedicated page on OpenFOAM available [here](../../../../openFOAM.md). +We have a dedicated page on OpenFOAM available [here](../../../../openFOAM.md). From 48f7963f1be7239c42aa47fcc145733b3993fbdc Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 10:40:06 +0200 Subject: [PATCH 07/18] add readme --- mkdocs/docs/HPC/only/gent/available_software/custom/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 mkdocs/docs/HPC/only/gent/available_software/custom/README.md diff --git a/mkdocs/docs/HPC/only/gent/available_software/custom/README.md b/mkdocs/docs/HPC/only/gent/available_software/custom/README.md new file mode 100644 index 000000000000..0cfb3a83dc24 --- /dev/null +++ b/mkdocs/docs/HPC/only/gent/available_software/custom/README.md @@ -0,0 +1,4 @@ +# Custom text for available software + +This folder must contain markdown files precisely matching names of software packages available on the HPC cluster. +The MarkDown in these files will be included in the available_software/detail pages. \ No newline at end of file From 437fc90b5d12400f7d2b6da26790aaf554260db3 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 11:07:10 +0200 Subject: [PATCH 08/18] add python custom text --- mkdocs/docs/HPC/only/gent/available_software/custom/Python.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 mkdocs/docs/HPC/only/gent/available_software/custom/Python.md diff --git a/mkdocs/docs/HPC/only/gent/available_software/custom/Python.md b/mkdocs/docs/HPC/only/gent/available_software/custom/Python.md new file mode 100644 index 000000000000..3c0955dc74c3 --- /dev/null +++ b/mkdocs/docs/HPC/only/gent/available_software/custom/Python.md @@ -0,0 +1,2 @@ +We have a dedicated page on Python available [here](../../../../python.md). +For more info on python virtual environments, check out [this page](../../../../setting_up_python_virtual_environments.md) \ No newline at end of file From 82cdafcb4d04f1f3b613d7c63599b82cf42ee71b Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 11:15:18 +0200 Subject: [PATCH 09/18] use different folder for custom text --- scripts/available_software/available_software.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/available_software/available_software.py b/scripts/available_software/available_software.py index 14ea30321480..2662312baff7 100644 --- a/scripts/available_software/available_software.py +++ b/scripts/available_software/available_software.py @@ -78,7 +78,7 @@ def main(): print("Done!") print("Generate detailed pages... ", end="", flush=True) detail_folder = os.path.join(root_dir, "mkdocs/docs/HPC/only/gent/available_software/detail") - custom_text_folder = os.path.join(root_dir, "mkdocs/docs/HPC/module_custom_text") + custom_text_folder = os.path.join(root_dir, "mkdocs/docs/HPC/gent/available_software/custom") generated_time_yml = os.path.join(root_dir, "mkdocs/extra/gent.yml") # yml containing time the data was generated generate_detail_pages(json_path, detail_folder, custom_text_folder, generated_time_yml) print("Done!") From 3d9ee790ca137d495870af72835aa51ad0b12260 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 11:36:37 +0200 Subject: [PATCH 10/18] add 'only' to path of custom text --- scripts/available_software/available_software.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/available_software/available_software.py b/scripts/available_software/available_software.py index 2662312baff7..53dff861c88e 100644 --- a/scripts/available_software/available_software.py +++ b/scripts/available_software/available_software.py @@ -78,7 +78,7 @@ def main(): print("Done!") print("Generate detailed pages... ", end="", flush=True) detail_folder = os.path.join(root_dir, "mkdocs/docs/HPC/only/gent/available_software/detail") - custom_text_folder = os.path.join(root_dir, "mkdocs/docs/HPC/gent/available_software/custom") + custom_text_folder = os.path.join(root_dir, "mkdocs/docs/HPC/only/gent/available_software/custom") generated_time_yml = os.path.join(root_dir, "mkdocs/extra/gent.yml") # yml containing time the data was generated generate_detail_pages(json_path, detail_folder, custom_text_folder, generated_time_yml) print("Done!") From a8a3c36713db7e6cc3d0fb4ceda62fcd8530e840 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 11:44:12 +0200 Subject: [PATCH 11/18] remove newline before custom text --- scripts/available_software/available_software.py | 1 - 1 file changed, 1 deletion(-) diff --git a/scripts/available_software/available_software.py b/scripts/available_software/available_software.py index 53dff861c88e..168ce12238d1 100644 --- a/scripts/available_software/available_software.py +++ b/scripts/available_software/available_software.py @@ -378,7 +378,6 @@ def generate_software_detail_page( filename = f"{path}/{software_name}.md" md_file = MdUtils(file_name=filename, title=f"{software_name}") - md_file.new_line() md_file.write(get_custom_markdown_text(software_name, custom_text_folder)) md_file.new_header(level=1, title="Available modules") From c6e151bdf2f4fe1e8859cbf93a236c2e28757ebe Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 11:48:03 +0200 Subject: [PATCH 12/18] newlines before and after inserted custom text --- scripts/available_software/available_software.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/available_software/available_software.py b/scripts/available_software/available_software.py index 168ce12238d1..60a59cf8e88e 100644 --- a/scripts/available_software/available_software.py +++ b/scripts/available_software/available_software.py @@ -419,7 +419,7 @@ def get_custom_markdown_text(module_name: str, custom_text_folder: str) -> str: print(f"Adding custom text for {module_name} located at {custom_markdown_path}") with open(custom_markdown_path, 'r') as f: - return f.read() + return "\n" + f.read() + "\n" def generate_detail_pages(json_path, dest_path, custom_text_folder, generated_time_yml) -> None: From 37c9b4283cbe3c09d12b1bec6007c24fe59ac63b Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Tue, 17 Sep 2024 11:58:06 +0200 Subject: [PATCH 13/18] dont change openfoam entry in detail folder --- .../docs/HPC/only/gent/available_software/detail/OpenFOAM.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/mkdocs/docs/HPC/only/gent/available_software/detail/OpenFOAM.md b/mkdocs/docs/HPC/only/gent/available_software/detail/OpenFOAM.md index 73acf70039f2..b57d42de0b05 100644 --- a/mkdocs/docs/HPC/only/gent/available_software/detail/OpenFOAM.md +++ b/mkdocs/docs/HPC/only/gent/available_software/detail/OpenFOAM.md @@ -6,9 +6,6 @@ hide: OpenFOAM ======== -We also have a dedicated page on OpenFOAM available [here](../../../../openFOAM.md). - - # Available modules From bfbf9e73bc61d70910211709c40a06b7ae286093 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres <63658577+lbarraga@users.noreply.github.com> Date: Thu, 19 Sep 2024 17:18:59 +0200 Subject: [PATCH 14/18] python -> Python Co-authored-by: Kenneth Hoste --- mkdocs/docs/HPC/only/gent/available_software/custom/Python.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/docs/HPC/only/gent/available_software/custom/Python.md b/mkdocs/docs/HPC/only/gent/available_software/custom/Python.md index 3c0955dc74c3..345a9980b301 100644 --- a/mkdocs/docs/HPC/only/gent/available_software/custom/Python.md +++ b/mkdocs/docs/HPC/only/gent/available_software/custom/Python.md @@ -1,2 +1,2 @@ We have a dedicated page on Python available [here](../../../../python.md). -For more info on python virtual environments, check out [this page](../../../../setting_up_python_virtual_environments.md) \ No newline at end of file +For more info on Python virtual environments, check out [this page](../../../../setting_up_python_virtual_environments.md) \ No newline at end of file From c3928094da72157f44c1296114c9fbf60af70e5d Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Thu, 19 Sep 2024 17:03:43 +0200 Subject: [PATCH 15/18] add section on inserting custom markdown in available_software/README.md --- scripts/available_software/README.md | 42 ++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/scripts/available_software/README.md b/scripts/available_software/README.md index f48a8d2c2235..ac6eccd1aee1 100644 --- a/scripts/available_software/README.md +++ b/scripts/available_software/README.md @@ -36,6 +36,48 @@ You can run the script with following command: python available_software.py ``` +## Adding custom text to a software page + +Some software pages benefit from having additional information. For example, a link to software specific documentation. + +Custom markdown file located in `mkdocs/docs/HPC/only/gent/available_software/custom` will be inserted into the detailed software page. +This file must match the name of the module exactly. + +For example: + +- `mkdocs/docs/HPC/only/gent/available_software` + - `custom/` + - ... + - Python.md + - ... + - `detail/` + - ... + - Python.md + - ... + +Where the content of `custom/Python.md` is: + +```md +We have a dedicated page on Python available [here](../../../../python.md). +For more info on python virtual environments, check out [this page](../../../../setting_up_python_virtual_environments.md) +``` + +After running `available_software.py`, the contents of `detail/Python.md` will be + +```md +Python +====== + +We have a dedicated page on Python available [here](../../../../python.md). +For more info on python virtual environments, check out [this page](../../../../setting_up_python_virtual_environments.md) + +# Available modules + + +The overview below shows which Python installations are available per HPC-UGent Tier-2 cluster, ordered based on software version (new to old). +... +``` + ## Testing You can run the tests by running the `test.sh` script. ```shell From f4cd2c968b19257e356c4fa4c769d6e3498bbdfe Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Thu, 19 Sep 2024 17:18:42 +0200 Subject: [PATCH 16/18] add README at only/gent/available_software --- .../docs/HPC/only/gent/available_software/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 mkdocs/docs/HPC/only/gent/available_software/README.md diff --git a/mkdocs/docs/HPC/only/gent/available_software/README.md b/mkdocs/docs/HPC/only/gent/available_software/README.md new file mode 100644 index 000000000000..bf29bedd6404 --- /dev/null +++ b/mkdocs/docs/HPC/only/gent/available_software/README.md @@ -0,0 +1,12 @@ +# Available Software + +This folder contains the following automatically generated directories: +- `detail/`: contains detailed software pages that are generated by the script `available_software.py`. +- `data/`: contains the data that is used to generate the detailed software pages + +and the following manually created directories: + +- `custom/`: contains custom markdown files that can be inserted into the detailed software pages. +- `javascript/`: contains the javascript that is used to generate the overview table. + +For more info on the purpose of these directories, see the README at scripts/available_software/README.md \ No newline at end of file From a83bf9c1bbd1c07dd0655594fc20b39278c5642f Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Thu, 19 Sep 2024 17:20:51 +0200 Subject: [PATCH 17/18] module name -> software name --- scripts/available_software/available_software.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/available_software/available_software.py b/scripts/available_software/available_software.py index 60a59cf8e88e..075adff6fad4 100644 --- a/scripts/available_software/available_software.py +++ b/scripts/available_software/available_software.py @@ -405,18 +405,18 @@ def generate_software_detail_page( f.write("---\nhide:\n - toc\n---\n" + read_data) -def get_custom_markdown_text(module_name: str, custom_text_folder: str) -> str: +def get_custom_markdown_text(software_name: str, custom_text_folder: str) -> str: """ Get the custom Markdown text that will be added to the detailed Markdown pages. @return: Custom Markdown text """ - custom_markdown_path = os.path.join(custom_text_folder, module_name + ".md") + custom_markdown_path = os.path.join(custom_text_folder, software_name + ".md") if not os.path.exists(custom_markdown_path): return "" - print(f"Adding custom text for {module_name} located at {custom_markdown_path}") + print(f"Adding custom text for {software_name} located at {custom_markdown_path}") with open(custom_markdown_path, 'r') as f: return "\n" + f.read() + "\n" From 3825896d77514fded2a1185ab2093a06a2551847 Mon Sep 17 00:00:00 2001 From: Lukas Barragan Torres Date: Thu, 19 Sep 2024 17:25:26 +0200 Subject: [PATCH 18/18] README now txt --- .../only/gent/available_software/{README.md => README.txt} | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) rename mkdocs/docs/HPC/only/gent/available_software/{README.md => README.txt} (85%) diff --git a/mkdocs/docs/HPC/only/gent/available_software/README.md b/mkdocs/docs/HPC/only/gent/available_software/README.txt similarity index 85% rename from mkdocs/docs/HPC/only/gent/available_software/README.md rename to mkdocs/docs/HPC/only/gent/available_software/README.txt index bf29bedd6404..66eb2fd5145e 100644 --- a/mkdocs/docs/HPC/only/gent/available_software/README.md +++ b/mkdocs/docs/HPC/only/gent/available_software/README.txt @@ -9,4 +9,6 @@ and the following manually created directories: - `custom/`: contains custom markdown files that can be inserted into the detailed software pages. - `javascript/`: contains the javascript that is used to generate the overview table. -For more info on the purpose of these directories, see the README at scripts/available_software/README.md \ No newline at end of file +For more info on the purpose of these directories, see the README at scripts/available_software/README.md + +(this is a txt as to not be included in the mkdocs build) \ No newline at end of file