Skip to content
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

Merged
merged 1 commit into from
Aug 10, 2023

Conversation

story645
Copy link
Member

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.

@story645 story645 added the Documentation: build building the docs label Aug 10, 2023
doc/conf.py Outdated
Comment on lines 30 to 31
import pydata_sphinx_theme
import mpl_sphinx_theme
Copy link
Member

@QuLogic QuLogic Aug 10, 2023

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.

Copy link
Member Author

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

@timhoffm
Copy link
Member

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.

@story645
Copy link
Member Author

Generally I find it more helpful there as it persists with the pages. The Sphinx output is quite lengthy

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.

@tacaswell
Copy link
Member

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.

Copy link
Member

@timhoffm timhoffm left a 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.

@tacaswell tacaswell added this to the v3.9.0 milestone Aug 10, 2023
@tacaswell tacaswell merged commit 5bdf0e0 into matplotlib:main Aug 10, 2023
31 of 32 checks passed
@story645 story645 deleted the print-sphinx branch October 12, 2023 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: build building the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants