Skip to content

Read The Docs TOC Footer Not Loading and Throwing Errors #2015

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

Closed
sahilTakiar opened this issue Feb 25, 2016 · 6 comments
Closed

Read The Docs TOC Footer Not Loading and Throwing Errors #2015

sahilTakiar opened this issue Feb 25, 2016 · 6 comments
Labels
Bug A bug

Comments

@sahilTakiar
Copy link

Details

If this issue is for a specific project or build, include the following:

When loading the project page, the Chrome Inspect tool throws an error saying: Failed to load resource: the server responded with a status of 404 (NOT FOUND) https://readthedocs.org//api/v2/footer_html/?callback=jQuery211025191313796…2Fcheckouts%2Freadthedocs%2Fgobblin-docs&source_suffix=.md&_=1456430887845

and Error loading Read the Docs footer $.ajax.error @ readthedocs-doc-embed.js:1

I notice that the Read the Docs tab on the bottom left of the screen (at the bottom of the main TOC) is not loading. I'm guessing these are related, but any idea why this is happening? Is this a bug? Has anyone else seen this issue?

screen shot 2016-02-25 at 12 11 20 pm

@sahilTakiar
Copy link
Author

For reference my mkdocs.yml file is here: https://github.com/linkedin/gobblin/blob/readTheDocs/mkdocs.yml

The docs are checked into the following branch of this GitHub Project: https://github.com/linkedin/gobblin/tree/readTheDocs and are under the folder gobblin-docs

The ReadTheDocs Admin Page is here: https://readthedocs.org/projects/gobblin/
The ReadTheDocs Home Page is here: http://gobblin.readthedocs.org/en/readthedocs/

@agjohnson
Copy link
Contributor

For some reason, the URL requested includes an incorrect version slug of: &version=readTheDocs. It should be the version slug, ie:&version=readthedocs. This seems like whatever Mkdocs is using here is incorrect.

@agjohnson agjohnson added Triage: Mkdocs Support Support question Bug A bug and removed Support Support question labels Feb 26, 2016
@agjohnson
Copy link
Contributor

@sahilTakiar
Copy link
Author

Thanks a ton for the investigation @agjohnson

Should I go ahead and open an Issue on the Mkdocs GitHub?

If the change is as simple as 'version': self.version.verbose_name, to 'version': self.version.slug, I can create the PR too

@agjohnson
Copy link
Contributor

A PR would be 💯 I believe that change should be enough. I don't use Mkdocs and haven't tested this however.

sahilTakiar pushed a commit to sahilTakiar/readthedocs.org that referenced this issue Feb 26, 2016
ericholscher added a commit that referenced this issue Feb 27, 2016
#2015 Fix ReadTheDocs footer not loading for mkdocs
@sahilTakiar
Copy link
Author

I checked http://gobblin.readthedocs.org/en/readthedocs/ and this is working now thanks everyone!

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

No branches or pull requests

2 participants