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

Readthedocs PDF format not building #630

Closed
bernardcooke53 opened this issue Jul 17, 2023 · 6 comments
Closed

Readthedocs PDF format not building #630

bernardcooke53 opened this issue Jul 17, 2023 · 6 comments
Labels
bug Something isn't working properly stale

Comments

@bernardcooke53
Copy link
Contributor

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.

@bernardcooke53 bernardcooke53 added the bug Something isn't working properly label Jul 17, 2023
@bernardcooke53 bernardcooke53 pinned this issue Jul 17, 2023
@MicaelJarniac
Copy link
Contributor

I've opened #631 to fix one of the problems with the new docs.

@bernardcooke53 bernardcooke53 mentioned this issue Jul 17, 2023
@bernardcooke53
Copy link
Contributor Author

I've pushed up a change to the readthedocs config reducing the formats to just htmlzip, let's see if that gets something built

@bernardcooke53
Copy link
Contributor Author

That suggestion worked @MicaelJarniac - thank you! Docs are updated now, no additional downloadable formats for the moment but I don't think that's a major concern

@MicaelJarniac
Copy link
Contributor

That's great news! I'm poking around to see if I can figure something out.

@bernardcooke53 bernardcooke53 changed the title Readthedocs not updated with v8 documentation Readthedocs PDF format not building Jul 17, 2023
@bernardcooke53 bernardcooke53 unpinned this issue Jul 17, 2023
@bernardcooke53
Copy link
Contributor Author

Unpinned now the docs are out with the major version, I guess there'll be fewer people coming to the issues who'll need to know about just the missing formats

Copy link

This issue is stale because it has not been confirmed or planned by the maintainers and has been open 90 days with no recent activity. It will be closed in 7 days, if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale label Mar 25, 2024
@codejedi365 codejedi365 closed this as not planned Won't fix, can't repro, duplicate, stale Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working properly stale
Projects
None yet
Development

No branches or pull requests

3 participants