pydata-sphinx-theme icon indicating copy to clipboard operation
pydata-sphinx-theme copied to clipboard

Create more verbosity in our `stb compile` step for publishing the package

Open choldgraf opened this issue 3 years ago • 0 comments

Description

Right now, we publish our package via python -m build in this GitHub Action:

https://github.com/pydata/pydata-sphinx-theme/blob/ef7d5a28f0b3354b2c71cc7bd041f607e315eb99/.github/workflows/tests.yml#L161-L181

The things that happen inside of python -m build are somewhat opaque, and we should find a way to make the logs more verbose so that we know exactly what was run as part of the publishing process.

Guide

@pradyunsg provided some guidance about what is happening here:

Wheel generation calling generate_assets:

https://github.com/pradyunsg/sphinx-theme-builder/blob/10450cfeb65bc3610a6708ee731069c707978fef/src/sphinx_theme_builder/_internal/distributions.py#L157

stb compile calling generate_assets:

https://github.com/pradyunsg/sphinx-theme-builder/blob/10450cfeb65bc3610a6708ee731069c707978fef/src/sphinx_theme_builder/_internal/cli/compile.py#L26

so we should document this in our dev docs, as well as add some more verbosity to our GitHub Action for publishing.

choldgraf avatar Jan 14 '22 17:01 choldgraf