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

[choldgraf]

Description

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

pydata-sphinx-theme/.github/workflows/tests.yml

Lines 161 to 181 in ef7d5a2

	publish:
	name: Publish to PyPI
	needs: [lint, tests]
	if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v2
	- name: Set up Python 3.7
	uses: actions/setup-python@v1
	with:
	python-version: 3.7
	- name: Build package
	run: |
	python -m pip install -U pip build
	python -m build
	- name: Publish
	uses: pypa/gh-action-pypi-publish@v1.1.0
	with:
	user: __token__
	password: ${{ secrets.PYPI_KEY }}

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.

[trallard]

Closing as this is now stale with recent updates to our workflows and CI