search

executablebooks / sphinx-exercise

A Sphinx extension for producing exercise and solution directives.
https://ebp-sphinx-exercise.readthedocs.io
MIT License
18 stars 6 forks source link

Empty box title #28

Closed fmaussion closed 2 years ago

fmaussion commented 3 years ago

Do you have any idea of what could silently lead to this behavior?

image

This used to work on my book last week, and does not work anymore today. I have been trying to track it down to package updates but without success so far...

fmaussion commented 3 years ago

For the record, this still occurs on a fresh, clean environment: 

$ jupyter-book --version
Jupyter Book: 0.8.3
MyST-NB: 0.10.1
Sphinx Book Theme: 0.0.39
MyST-Parser: 0.12.10
Jupyter-Cache: 0.4.1
NbClient: 0.5.1
najuzilu commented 3 years ago

Hi @fmaussion I'll look into this now. I suspect it might have something to do with the Sphinx upgrade. Could you let me know which version of Sphinx you are using?

najuzilu commented 3 years ago

I suspect it might have something to do with the Sphinx upgrade.

My suspicion was wrong. I tried to replicate the issue here with no luck. This is also my environment:

Jupyter Book: 0.8.3
MyST-NB: 0.10.1
Sphinx Book Theme: 0.0.39
MyST-Parser: 0.12.10
Jupyter-Cache: 0.4.1
NbClient: 0.5.1
Sphinx: 3.2.1

Could you let me know if you're using any other extensions?

AckslD commented 3 years ago

@najuzilu @fmaussion I'm also getting the missing title. I'm using sphinx 3.3.0 and sphinx-exercise 0.1.1 with the following extensions:

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.githubpages',
    'sphinx.ext.todo',
    'sphinx.ext.mathjax',
    'sphinx.ext.intersphinx',
    'sphinx.ext.doctest',
    'sphinx.ext.extlinks',
    'sphinx_autodoc_typehints',
    'sphinx_exercise',
]

Edit: Actually my box looks even more strange:

gscreenshot_2020-11-13-135257

najuzilu commented 3 years ago

Ah, I think I know what the issue is. Could you downgrade to Sphinx version 3.2.1 and let me know if you still get an issue?

The extension doesn't work with Sphinx version 3.3.0 because of they've skipped all enumerable nodes with no title. I'm working towards a workaround to address this issue.

fmaussion commented 3 years ago

Note that for my use case I would even be happier without exercise numbers - if there would be an option to disable numbering as well that would be great!!!

fmaussion commented 3 years ago

I'll try older sphinx later today

fmaussion commented 3 years ago

I can confirm that it works with Sphinx v3.2.1