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

docs should include that `sphinx_book_theme` is required #38

Closed goekce closed 2 years ago

goekce commented 2 years ago

Description / Summary

Without html_theme = 'sphinx_book_theme' in conf.py the exercise and solutions lack the icons on the top left side. It would be great if this theme is recommended in https://ebp-sphinx-exercise.readthedocs.io/en/latest/index.html#sphinx-project

To see the issue use the default theme html_theme = 'alabaster'

Value / benefit

People who are new to this project would spend less time for debugging :)

Implementation details

No response

Tasks to complete

No response

welcome[bot] commented 2 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

mmcky commented 2 years ago

thanks @goekce -- sorry this took me so long to get to.

I have now added this to the docs and opened #52