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

BUG: Released documentation unreachable #15545

Closed
maxnoe opened this issue Feb 7, 2022 · 13 comments
Closed

BUG: Released documentation unreachable #15545

maxnoe opened this issue Feb 7, 2022 · 13 comments
Labels
defect A clear bug or issue that prevents SciPy from being installed or used as expected

Comments

@maxnoe
Copy link
Contributor

maxnoe commented Feb 7, 2022

It seems the documentation page is down?

https://docs.scipy.org/doc/scipy/

@maxnoe maxnoe added the defect A clear bug or issue that prevents SciPy from being installed or used as expected label Feb 7, 2022
@bjodah
Copy link
Contributor

bjodah commented Feb 7, 2022

Seems like it, as a work-around, I'm using google to directly search the docs of the dev-snapshot, i.e. search using the site: specifier:

pchip integrator site:scipy.github.io/devdocs/

@tylerjereddy
Copy link
Contributor

Can you try again now? It works for me.

For the record, this is the current set of web server config adjustments I've made--more robust suggestions are welcome:
tylerjereddy/htaccess_backup#1

@maxnoe
Copy link
Contributor Author

maxnoe commented Feb 7, 2022

I am still getting a blank page for the link above, it seems redirects are not working as intended.

The link now seems to be https://docs.scipy.org/doc/scipy/html-scipyorg/, which is working, but e.g. getting the intersphinx directory does not:

https://docs.scipy.org/doc/scipy/html-scipyorg/objects.inv

Where it works with 1.8.0 explicitly:

https://docs.scipy.org/doc/scipy-1.8.0/html-scipyorg/objects.inv

@tylerjereddy
Copy link
Contributor

There should be an automatic redirect for https://docs.scipy.org/doc/scipy/ now

@tylerjereddy
Copy link
Contributor

Not sure how sustainable it is for me to manually patch individual broken links in .htaccess. This was always the problem with the new doc theme, which moves things around but was never really tested in a release deployment.

I'll see what I can do, but specific suggestions to adjust tylerjereddy/htaccess_backup#1 are appreciated.

There's a symlink from scipy to the latest release dir scipy-1.8.0, but there is also a need to remap scipy-1.8.0/reference to scipy-1.8.0/html-scipyorg/reference.

@matthewfeickert
Copy link

There should be an automatic redirect for https://docs.scipy.org/doc/scipy/ now

There's a symlink from scipy to the latest release dir scipy-1.8.0, but there is also a need to remap scipy-1.8.0/reference to scipy-1.8.0/html-scipyorg/reference.

Thanks for the responsive work here @tylerjereddy. If we're still seeing

WARNING: failed to reach any of the inventories with the following issues:
intersphinx inventory 'https://docs.scipy.org/doc/scipy/reference/objects.inv' not readable due to ValueError: unknown or unsupported inventory version: ValueError('invalid inventory header: ')

in CI jobs (scikit-hep/pyhf#1766), even though the redirect is already in effect, is the recommendation to just be patient and let things finish rolling out? Or is this indicative of further problems?

@tylerjereddy
Copy link
Contributor

@matthewfeickert We're still having problems I think--I can't quite get the redirect working yet, but there are some suggestions in tylerjereddy/htaccess_backup#1

So far, the suggestions that I have tried for .htaccess changes have had other side effects, but hopefully we'll find something that works eventually.

I tried messing around with stuff like scipy/reference/objects.inv to scipy/html-scipyorg/objects.inv (the new location), but no success yet.

@matthewfeickert
Copy link

Thanks for the update in general and also thanks for the work that you're doing to address this problem.

I tried messing around with stuff like scipy/reference/objects.inv to scipy/html-scipyorg/objects.inv (the new location), but no success yet.

Ah, this is good to know in general. Even if things aren't working with https://docs.scipy.org/doc/scipy/html-scipyorg/objects.inv quite yet this is still good to know that people should be updating their Sphinx conf.pys to use the new address to avoid the redirect anyway. Thanks for this!

@pllim
Copy link
Contributor

pllim commented Feb 8, 2022

FWIW, scipy.fft intersphinx used to work but no longer. The page is up though at https://docs.scipy.org/doc/scipy-1.8.0/html-scipyorg/reference/fft.html but I get this: py:obj reference target not found: scipy.fft

@tylerjereddy
Copy link
Contributor

I've deployed the latest suggestions from @maxnoe over in tylerjereddy/htaccess_backup#1 (thanks!). It seems to work as well as our best previous solution, but I don't yet see an advantage for accessing i.e., https://docs.scipy.org/doc/scipy/html-scipyorg/objects.inv?

@matthewfeickert
Copy link

It seems to work as well as our best previous solution, but I don't yet see an advantage for accessing i.e., https://docs.scipy.org/doc/scipy/html-scipyorg/objects.inv?

Ah, indeed, now we get this nice warning telling use what to use. 👍

intersphinx inventory has moved: https://docs.scipy.org/doc/scipy/reference/objects.inv -> https://docs.scipy.org/doc/scipy/objects.inv

Thanks!

@tylerjereddy
Copy link
Contributor

Ok, great, looks like we can perhaps suggest intersphinx changes like the one here: https://github.com/scikit-hep/pyhf/pull/1767/files

for downstream packages.

I've also made a note to add @maxnoe to the author list for SciPy 1.8.1 for fixing this up for us, many thanks.

@maxnoe
Copy link
Contributor Author

maxnoe commented Feb 8, 2022

I think we can close this, everything seems to be working from my side.

CagtayFabry pushed a commit to BAMWelDX/weldx that referenced this issue Feb 8, 2022
* [doc] fix intersphinx link

xref:
 scipy/scipy#15545,
 apache/tvm#10181

* [doc] added nitpick ignore for asdf-2.9.1
QuLogic added a commit to QuLogic/matplotlib that referenced this issue Feb 9, 2022
As noted in scipy/scipy#15545 the object
inventory has moved. Though there's a redirect, it has paths like
`reference/..` which doubles the `reference` in the URL.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defect A clear bug or issue that prevents SciPy from being installed or used as expected
Projects
None yet
Development

No branches or pull requests

5 participants