-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC]: print pydata sphinx/mpl theme versions #26482
Conversation
doc/conf.py
Outdated
import pydata_sphinx_theme | ||
import mpl_sphinx_theme |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is probably too early; it is importing before the _check_dependencies
call.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
moved print to inside check dependencies
The html footer of the theme now contains the Sphinx and pydatasphinx theme version. Maybe one could inject the mpl theme version there? Generally I find it more helpful there as it persists with the pages. The Sphinx output is quite lengthy and I wouldn't try searching that for the version info. |
My docs won't build b/c far as I can tell new sphinx and new-pydata broke windows, and these print up top right after the mpl build version - 4th line. |
This is probably most useful on CI where you do not have interactive access to the build environment to ask it what versions you are using. Having these printed out is nicer to find than searching through pip/conda logs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This certainly has its use.
top of the build prints the sphinx version, figure it may as well also print the pydata sphinx and mpl-theme versions to help with debugging.