add documentation on deprecated easyconfigs/toolchains #468
Conversation
ocaisa
left a comment
ocaisa
left a comment
There was a problem hiding this comment.
LGTM Have you got a rendered version just to double check the formatting?
|
@ocaisa Wasn't there yet because there was an issue with readthedocs, but it's there now, see https://boegel-eb.readthedocs.io/en/deprecated_ecs_tcs/Deprecated-easyconfigs.html |
|
|
||
| Using an easyconfig file or toolchain that was marked as deprecated results in a warning message like:: | ||
|
|
||
| WARNING: Deprecated functionality, will no longer work in v4.0: easyconfig file '/home/example/test.eb' is marked as deprecated: |
There was a problem hiding this comment.
These blocks are being syntax highlighted (for Python I think). Not a sphinx expert but should be easy to switch off.
There was a problem hiding this comment.
You would expect this to be easy to fix, turns out it's not...
With .. code:: none, the block is not displayed at all, with .. code:: text I'm still getting highlighting.
I'll keep poking at it, thanks for pointing this out, it indeed looks a bit silly this way...
…deprecated easyconfigs
boegel
force-pushed
the
deprecated_ecs_tcs
branch
from
2778350 to
09ccdf7
Compare
|
Seems to be ok now, if you're ok with it I can merge |
|
According to https://stackoverflow.com/questions/44376893/selectively-disable-readthedocs-syntax-highlighting you also could have used |
|
@ocaisa Tried Anyway, problem fixed indeed, good to go imho! |
|
Yeah, I think it's a sphinx option as opposed to an rst option |
2 participants
see also easybuilders/easybuild-framework#2656