Projects using sphinx_wagtail_theme are not picking up the dependency for sphinx_copybutton

[lb-]

I would have expected that installing sphinx_wagtail_theme would also ensure that sphinx_copybutton is made available, but this seems to wrong.

When using this theme in Wagtail, we have to explicitly add sphinx_copybutton, it would be good if we did not have to do that. Unless it is kind of expected that this would be required manually.

Expected solution

1. Add docs to this project to ensure that sphinx_copybutton is added by those using this theme
2. Explore/add whatever config 'magic' is needed to make this work automatically.

See original comment

(Regarding why it isn't picking up the dependency in sphinx_wagtail_theme - is that actually defined anywhere other than requirements.txt? That won't get picked up when packaging sphinx_wagtail_theme for pypi, unless there's some config magic I'm unaware of...)

Originally posted by @gasman in wagtail/wagtail#9339 (comment)

Relates to

• Added a sphinx-copy button to code snippets #219
• Code snippets copy to clipboard #45
• Documentation - update sphinx theme to fix dark mode issues + add copy code button wagtail#9339

[lb-]

Note: I am new to package management in Python land so this could possibly be a complete confusion on my part about Python vs NPM package nested dependencies.

[mohammadareeb95]

This is strange because sphinx_copybutton is also listed on the requirements.txt file.

Can I be of any help here?

[gasman]

@mohammadareeb95 As mentioned in my comment quoted above - I'm pretty sure that putting it in requirements.txt is not enough for it to be handled automatically as a dependency when installing the package. requirements.txt is just a convenience for people setting up the package manually. To be a proper dependency, it needs to be defined in setup.py (at least, when using the traditional setuptools - for alternatives like flit it might be different).