Where to place config info when using ReST?

[deeplook]

@choldgraf I want to use sphinx-thebe with ReST, but I'm missing any information where to place config information about binderOptions and kernelOptions.

[choldgraf]

hey @deeplook - these options are all configured automatically from the configuration of your repository that you put in conf.py:

https://github.com/executablebooks/sphinx-thebe/blob/master/sphinx_thebe/__init__.py#L97

see the configuration page for reference:

https://sphinx-thebe.readthedocs.io/en/latest/configure.html

does that not work for you?

[deeplook]

@choldgraf I had seen that configuration page, but it has some potential to confuse people, like me, as it does not mention conf.py anywhere. And in the last section it says: "Here’s a reference of all of the configuration values avialable to sphinx-thebe.", but misses codemirror-theme from a section above.

After pip install sphinx_thebe and equivalent edits in my conf.py I see no editable cells after running make html:

extensions = [
    # ...
    'sphinx_thebe'
]

thebe_config = {
    "repository_url": "https://github.com/my/repo",
    "repository_branch": "master",
    "selector": "div.thebe",
}

and this in hello.rst:

.. code-block:: python
   :class: thebe
   print("Hello World!")

Also, the config field names seem to be named differently from thebelab which I have tested ok briefly before.

[choldgraf]

@deeplook - you're right, I think that we can improve the documentation here and potentially reduce some confusion around having multiple configuration patterns for the same thing.

I've also opened up #17 to discuss standardizing the configuration value names 👍

[deeplook]

Can you point me to an existing example using ReST, similar to my description above?

[choldgraf]

Well right now I don't believe it is possible to configure thebe from within rST, the only configuration comes via the conf.py configuration. :-/

what's the thing you're trying to do that you cannot accomplish with conf.py configuration? That might be your only option until we can document / expand the configuration (e.g. via #17)

[deeplook]

I am ok with conf.py, I just wish it would work. ;)

[choldgraf]

me too 😬 sorry - this is a young package so still working out the kinks!

[deeplook]

Funny, but I found out that it actually works after I add this button to the ReST source:

.. thebe-button:: Run Thebe!

But after I click on the button the code cell styling (in my case set by sphinx_rtd_theme gets modified quite a bit), see GIF.

[choldgraf]

yep - that is to be expected, it uses CodeMirror for the interactive cells, which apply a different styling etc. You can try modifying either with other themes or by applying your own CSS to the site.

Do you think this issue can be closed?

[deeplook]

Feel free to close it. Maybe the documentation issue can be handled separately (?).

[choldgraf]

yeah - for sure there is still more to do!