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

bad link on docs.pylonsproject.org search page #3026

Closed
4b5ent1 opened this issue May 2, 2017 · 5 comments
Closed

bad link on docs.pylonsproject.org search page #3026

4b5ent1 opened this issue May 2, 2017 · 5 comments

Comments

@4b5ent1
Copy link

4b5ent1 commented May 2, 2017

Recently I use the html version searching the document and found that, for example:
http://docs.pylonsproject.org/projects/pyramid/en/latest/search.html?q=cache_max_age

In result, the link of pyramid.config will refer to:
http://docs.pylonsproject.org/projects/pyramid/en/latest/api/config.rst.html?highlight=cache_max_age

However that's a wrong place now. The true URL is this one:
http://docs.pylonsproject.org/projects/pyramid/en/latest/api/config.html?highlight=cache_max_age
which the end of URL without the .rst extension name in the middle.

This problem also found on pyramid_cookbook's document search page and some else.

@mmerickel
Copy link
Member

This is known[1] and is something we cannot fix on our own unfortunately. I'll leave this issue open to track it however. Thanks for the report!

[1] readthedocs/readthedocs.org#2708

@mmerickel
Copy link
Member

It looks like we could pin to sphinx 1.4 but I'm not sure if we're depending on anything in 1.5 at this time.

@stevepiercy
Copy link
Member

We would also need to pin to docutils 0.11 because sphinx < 1.5 does not pin it to a compatible version of docutils. I'm inclined not to change our setup.py for this issue. But if we want to...

docs_extras = [
    # Pin Sphinx to 1.4.*  and docutils to 0.11 due to search issues with RTD:
    # https://github.com/rtfd/readthedocs-sphinx-ext/issues/25
    # https://github.com/sphinx-doc/sphinx/issues/3212#issuecomment-283756374
    'Sphinx == 1.4.*',
    'docutils == 0.11',

Here's the issue being tracked by RTD folks:
readthedocs/readthedocs-sphinx-ext#25

I've subscribed to both issue threads, so I'll get notification of any updates.

@stevepiercy
Copy link
Member

YAY! Fix is coming this week!
readthedocs/readthedocs.org#2708 (comment)

@stevepiercy
Copy link
Member

This is now fixed.
readthedocs/readthedocs.org#2708

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants