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

RTD/doc search results call Julia functions Python functions instead #11527

Closed
randyzwitch opened this issue Jun 1, 2015 · 42 comments
Closed
Labels
domain:docs This change adds or pertains to documentation

Comments

@randyzwitch
Copy link
Contributor

I wanted to read the documentation for Base.copy, and to my surprise the labels reference them as Python functions.

Did someone do a bulk overwrite on the docs? Here's the link and a screenshot

http://julia.readthedocs.org/en/latest/search/?q=copy&check_keywords=yes&area=default

screen shot 2015-06-01 at 4 30 23 pm

@JeffBezanson JeffBezanson added the domain:docs This change adds or pertains to documentation label Jun 1, 2015
@pao
Copy link
Member

pao commented Jun 1, 2015

Probably a Sphinx default that we fail to override. Fix will probably be in JuliaDoc. Research time!

@pao
Copy link
Member

pao commented Jun 1, 2015

Yes, the Julia domain inherits directly from the Python domain, with some overrides. I think this only affects search results.

@pao pao changed the title Documentation overwritten with Python references? RTD/doc search results call Julia functions Python functions instead Jun 1, 2015
@pao
Copy link
Member

pao commented Jun 1, 2015

I have no idea where this can be coming from--the only string reference to "Python" in the domain we do in fact replace, the default domain is set to "jl" in conf.py, and there is no translation done (language is set to default which is None) so the i18n engine can't be inserting it.

@yuyichao
Copy link
Contributor

yuyichao commented Jun 1, 2015

This only happens for the "latest" doc. Is there any difference between the latest and the 0.3 version?

@yuyichao
Copy link
Contributor

yuyichao commented Jun 1, 2015

And the Julia-CN doc search is also correct.

@pao
Copy link
Member

pao commented Jun 1, 2015

Except the search index might still be getting a translation?

dumping search index in English (code: en) ... done

@pao
Copy link
Member

pao commented Jun 1, 2015

Hrm...that's weird. I at least confirmed that the translation files aren't at fault. This looks like something thinks this reference is cross-domain (otherwise it would just be "function" according to the documentation of conf.py).

@pao
Copy link
Member

pao commented Jun 1, 2015

Changes in JuliaDoc between version used on release-0.3 and master: JuliaLang/JuliaDoc@0dd9903...012be05

It doesn't appear that much has been done to conf.py that hasn't been backported, either, just some changes to the sidebars. Nothing that should be influencing this.

@yuyichao
Copy link
Contributor

yuyichao commented Jun 1, 2015

So both of them are generated nightly as well?

@pao
Copy link
Member

pao commented Jun 1, 2015

They are both generated on a branch push (there's a webook that GitHub issues.)

@yuyichao
Copy link
Contributor

yuyichao commented Jun 2, 2015

It appears to be OK now???

@yuyichao
Copy link
Contributor

yuyichao commented Jun 2, 2015

Did anyone do anything and can this be closed now?

@pao
Copy link
Member

pao commented Jun 2, 2015

Didn't do a darn thing, but confirm fixed. I assume this is somehow RTD's doing.

@pao pao closed this as completed Jun 2, 2015
@yuyichao
Copy link
Contributor

yuyichao commented Jun 7, 2015

@pao Sorry to bother you again but the problem seems to be back .......

@yuyichao
Copy link
Contributor

yuyichao commented Jun 7, 2015

Still only for 0.4

@yuyichao
Copy link
Contributor

Ping. @pao ? The search result is still showing "Python Function" now...

@pao
Copy link
Member

pao commented Jun 11, 2015

We literally don't control this in any way, as proven by the fact it changed, then changed back, without touching anything. Perhaps we should bring it up with RTD.

@pao pao added the kind:upstream The issue is with an upstream dependency, e.g. LLVM label Jun 11, 2015
@yuyichao
Copy link
Contributor

Do they have a tracker?

@agjohnson
Copy link

RTD hasn't made any changes that would have affected this, I do see what looks like a corrupted build env on one of the servers however. This could result in transient failures like this -- though still not sure why the failure case generates invalid indexed titles.

@agjohnson
Copy link

Oh, and with maintainer status on the project, you can trigger a environment wipe on the project's version page:
https://readthedocs.org/projects/julia/versions/

@pao
Copy link
Member

pao commented Jun 11, 2015

cc @nolta @StefanKarpinski would one of you be able to trigger the environment wipe for latest?

@StefanKarpinski
Copy link
Sponsor Member

Actually, I don't think I'm an admin on this. At least I don't see it on my read the docs dashboard. @nolta – could you add @pao and myself?

@nolta
Copy link
Member

nolta commented Jun 11, 2015

Ok, added and wiped.

@pao
Copy link
Member

pao commented Jun 11, 2015

That does not appear to have fixed it.

@agjohnson
Copy link

Okay, after a deep dark rabbit hole, the domain in your docs now has the proper prefix on the latest build :)

This is using the same server that was problematic before, so hopefully this makes the builds consistent.

@pao
Copy link
Member

pao commented Jun 12, 2015

Deep and dark, indeed. Thanks for taking a look, and for the fix.

@pao
Copy link
Member

pao commented Jun 12, 2015

@agjohnson Sorry to bother you again, but the original issue reported here ("Python function" showing up in search results) is still present; are we waiting for the fix to be pushed to RTD in production? Or did I misunderstand what all got fixed (was it just the environment installation problem)?

@agjohnson
Copy link

@pao It was fixed, but seems one of the other build servers we are decommissioning has the outdated readthedocs-sphinx-ext 0.5.3 package, I'll update all of the build servers this morning.

@pao
Copy link
Member

pao commented Jun 12, 2015

Got it, thanks for the clarification.

@tkelman
Copy link
Contributor

tkelman commented Jun 12, 2015

I don't see "Python function" any more, looks fixed now.

@yuyichao
Copy link
Contributor

Fixed here too. Hopefully it won't come back anymore.....

@yuyichao
Copy link
Contributor

@agjohnson @pao It comes back for me again right now and IIRC at least once in the past week.

@pao
Copy link
Member

pao commented Jun 26, 2015

Seems to be transient (most recent works for me right now)--maybe one of their build servers is/was still not updated?

@agjohnson
Copy link

We just rolled all new build servers, so there may have been a point where the old extension was being pulled in. Definitely raise the issue on our tracker if it comes up again.

@pao
Copy link
Member

pao commented Jun 26, 2015

Will do, thanks.

@yuyichao
Copy link
Contributor

@agjohnson It is "Python function" at this moment again.... (and IIRC was correct sometime yesterday)

@yuyichao
Copy link
Contributor

Reported at readthedocs/readthedocs.org#1382

@tkelman
Copy link
Contributor

tkelman commented Jun 29, 2015

Depending on when it was built, this could easily have something to do with #11906 ?

@hayd
Copy link
Member

hayd commented Jun 29, 2015

It's now back to saying Julia function, but it's been off and on this entire time.

@pao
Copy link
Member

pao commented Jun 29, 2015

@tkelman, since none of that has touched the definitions in JuliaDoc, we shouldn't be able to break it from within the doc sources themselves, unless we explicitly generated rst which specifies that they are Python functions. Julia is the default type.

@yuyichao
Copy link
Contributor

Doesn't seems seems to be referenced here so JuliaLang/JuliaDoc#16

@JeffBezanson
Copy link
Sponsor Member

This is fixed and superseded by the new doc system.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

9 participants