Generic Sphinx-RST: PoC for including interactive elements in RST using java script

[k-dimple]

We want to check if we can include simple interactive elements in websites developed using reStructuredText.

Scenario: A command shown in a how-to guide uses a sample set of parameters (e.g. version, arch, ..). The allowed combination of values for each of the parameters are described ahead, but the user doesn't read it and just copies the example command and changes one parameter. This might not work since some of the parameters are inter-dependent.

So instead of giving a sample command, can we include a snippet generator that generates the correct command based on the parameters specified by the user (at runtime)?

Check if this can be done and if it works, create a proof-of-concept web page to show how it is done. A fork of an existing Sphinx based project (such as the documentation starter pack) can be used as the base for the PoC.

Possible approach: Inject raw HTML/javascript. A possibly useful discussion from stackoverflow about this is here.

[davidekete]

Hi @k-dimple, i'd like to work on this

[k-dimple]

Sure @davidekete! Feel free to work on it. I'll assign it to you, thanks!

[k-dimple]

@davidekete are you working on this issue? or planning to work on it sometime soon? If so, could you give us a rough estimate of by when you'll be able to do it? Thanks!

[davidekete]

@davidekete are you working on this issue? or planning to work on it sometime soon? If so, could you give us a rough estimate of by when you'll be able to do it? Thanks!

Hi @k-dimple, my apologies. I was away for a while, I should be able to push the changes by Monday. Thank you for your patience.

[k-dimple]

@davidekete no problem at all! There's no hurry, I just wanted to get an idea of whether you'll be working on it or not. Thanks! Do let me know if you have any questions.

[k-dimple]

Hi @davidekete are you still planning to work on this one? You seem to have quite a few issues assigned to you! If there's too much on your plate, we could always re-open it to see if someone else wants to work on it.

[davidekete]

Hi @davidekete are you still planning to work on this one? You seem to have quite a few issues assigned to you! If there's too much on your plate, we could always re-open it to see if someone else wants to work on it.

Hi @k-dimple, I'm currently working on this issue. It's just taking a little longer than I expected. I should be able to wrap it up soon.

[k-dimple]

Great to hear that! In that case, we can catch up whenever you are done. There's no real hurry like I mentioned earlier, but I didn't want it to be totally forgotten either! :)