easybuild icon indicating copy to clipboard operation
easybuild copied to clipboard

`docs/version-specific/eb_list_toolchains.txt` not getting generated

Open justbennet opened this issue 5 years ago • 1 comments

Opening this issue per @boegel in (closed) PR #603 and in Slack, 14 Mar, 2020.

The file docs/version-specific/eb_list_toolchains.txt is included by docs/eb_list_toolchains.rst, but nothing in the docs/scripts generates that file. It looks like it should be output from eb --list-toolchains --output-format=rst. It also looks like that command doesn't sort the toolchains but rather takes them as they come from the dictionary.

I will put in a PR at easybuild-framework to sort the toolchain names, which will make the output of eb --list-toolchains --output-format=rst suitably pretty for inclusion in the documentation and may make it more useful from the command line.

justbennet avatar Mar 14 '20 18:03 justbennet

After some further poking, it may be that simply changing the include line in docs/eb_list_toolchains.rst from

.. include:: version-specific/eb_list_toolchains.txt

to

.. include:: version-specific/toolchains.rst

and regenerating after easybuild-frameworks PR #3246 has been merged may solve the problem.

I don't know how to test that myself, and I'm reluctant to post a PR for something untested.

justbennet avatar Mar 14 '20 23:03 justbennet