search

pex-tool / pex

A tool for generating .pex (Python EXecutable) files, lock files and venvs.
https://docs.pex-tool.org/
Apache License 2.0
2.5k stars 257 forks source link

Documentation website is down/missing #2337

Closed Garulf closed 6 months ago

Garulf commented 6 months ago

404 Not Found error when attempting to access documentation at: pex.readthedocs.io

image

benjyw commented 6 months ago

Thanks for the report! We'll look into this ASAP.

Meanwhile this slightly earlier version appears to work: https://pex.readthedocs.io/en/v2.1.156/

benjyw commented 6 months ago

The RTD build has been failing with:

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.

That extension is used to generate apple help books (not that we are actually doing that AFAICT). RTD upgraded to a newer version of it a few days ago, and that version added a runtime check for Sphinx>=5.

Note that the build has been failing for longer than those few days - before this applehelp issue there was a similar issue due to RTD upgrading the alabaster Sphinx dep to a version that required Sphinx > 3.3.

So basically our pinning Sphinx and other deps low bites us periodically when we don't upgrade - since RTD itself is opinionated about versions. I will put up a fix to bring us forward to modern versions of these RTD deps.

jsirois commented 6 months ago

Thanks @benjyw. I like where the science docs landed some months back (besides being incomplete): they are built, tested and deployed in-house; so the 1st two steps are done in every CI run and can fail it if there is something wrong with full fidelity. The doc check I added to Pex here does not have that same fidelity with the deploy environment obviously!

Hopefully I can swing back soon here to do the same and self-host latest and embed current in Pex itself; thus doing away with all RTD supplies at this point, a version drop down for old docs.

jsirois commented 6 months ago

The doc check I added to Pex here ...

This was a confabulation. There is no such check in CI.

benjyw commented 6 months ago

Latest docs now build: https://pex.readthedocs.io/en/latest/

I've temporarily set the default version to 2.1.156 (instead of 2.1.159) so that https://pex.readthedocs.io/ doesn't 404. This will reset automatically on the next release.

jsirois commented 6 months ago

Thanks @benjyw. I was just updating science to the PBS 3.12.1 release et. al. and had my nox -e doc linkcheck fail because - low and behold:

Warning, treated as error:
/home/jsirois/dev/a-scie/lift/docs/_/manifest/interpreter.md:3:broken link: https://python-build-standalone.readthedocs.io (404 Client Error: Not Found for url: https://python-build-standalone.readthedocs.io/)
nox > Command sphinx-build -b linkcheck -aEW /home/jsirois/dev/a-scie/lift/docs /home/jsirois/dev/a-scie/lift/docs/build/linkcheck failed with exit code -11
nox > Session linkcheck-3.12 failed.
nox > Ran multiple sessions:
nox > * doc-3.12: success
nox > * linkcheck-3.12: failed

It looks like he got fed up too some time ago: https://gregoryszorc.com/docs/python-build-standalone/main/