The problem

The documentation for Python Semantic Release at https://python-semantic-release.readthedocs.io/en/latest/ is not updated for v8. The documentation build is currently failing.

Expected behavior

Docs to be updated

Environment

N/A

Configuration

N/A

! LaTeX Error: Unknown graphics extension: .yml.
...
! LaTeX Error: Unknown graphics extension: .svg.
...
! Package inputenc Error: Unicode char 💥 (U+1F4A5)
(inputenc) not set up for use with LaTeX.

See the inputenc package documentation for explanation.
...

Additional context

I'm seeing that readthedocs isn't updating with the docs for v8 - it looks like the docs build has been failing for a while, for a time it was due to the Sphinx version in use but then the error changed after this commit to other errors.

Workaround

While not ideal, you can either check the documentation directly in the source code of this repo, or you can clone & build the documentation locally to view in your web-browser:

git clone git@github.com:python-semantic-release/python-semantic-release.git
cd python-semantic-release
python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev, test, docs, mypy]"
cd docs/

You can then build the docs with the following:

Windows

make.bat livehtml

Mac/Linux

make livehtml

Open a new tab in the browser and go to http://localhost:8000 to view the documentation.

Will close this when the docs build is working again.