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

Read the Docs API documentation broken (automodule) #464

Closed
goetzb opened this issue Feb 26, 2018 · 8 comments
Closed

Read the Docs API documentation broken (automodule) #464

goetzb opened this issue Feb 26, 2018 · 8 comments

Comments

@goetzb
Copy link

goetzb commented Feb 26, 2018

Hi there,

Thank you for this useful app! Over the weekend, I've noticed that the documentation on Red the Docs looks broken. The API documentation from https://github.com/applegrew/django-select2/blob/master/docs/django_select2.rst seems no longer to evaluate the automodule directive correctly: http://django-select2.readthedocs.io/en/stable/django_select2.html
2018-02-26_django-select2_rtd_automodule_broken

A version from July last year on https://web.archive.org/web/20170731032619/http://django-select2.readthedocs.io/en/latest/django_select2.html displays all the auto-generated content as expected:
2018-02-26_django-select2_rtd_automodule_2017-07_archiveorg_working

I don't exactly know since when the documentation is broken - maybe Read the Docs changed some configuration options or a Sphinx update introduced some changes...

Unfortunately, I could also not yet work out what's wrong from just looking at the code, so I can't suggest a fix, but at least I wanted to report it.

Please let me know if you have any questions!

Thank you,
Goetz

@codingjoe
Copy link
Collaborator

This is very likely related to sphinx-doc/sphinx#4520
I downgraded the sphinx version.

@codingjoe
Copy link
Collaborator

That actually didn't have seem to fix it.

@codingjoe codingjoe reopened this Mar 7, 2018
@codingjoe
Copy link
Collaborator

@goetzb I currently don't have much time on my hand, if you would want to debug this, it would be more than welcome 😉

@goetzb
Copy link
Author

goetzb commented Mar 9, 2018

@codingjoe Thanks, I'll try to take a closer look over the coming days (or weeks... ;)

@codingjoe
Copy link
Collaborator

@goetzb yes, that would be cool! thx!

@codingjoe
Copy link
Collaborator

@goetzb I can not reproduce this locally. I asked @applegrew for access to the readthedocs project. I will look into the config there once I have access.

@codingjoe
Copy link
Collaborator

Fixed it 👍

@goetzb
Copy link
Author

goetzb commented Mar 11, 2018

Great, thanks! - I wanted to have a look at the problem tonight...

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

No branches or pull requests

2 participants