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

Python 3 only code results in empty docs with no configuration file #6515

Closed
s-t-e-v-e-n-k opened this issue Jan 11, 2020 · 2 comments
Closed
Labels
Needed: more information A reply from issue author is required Support Support question

Comments

@s-t-e-v-e-n-k
Copy link

Details

Expected Result

That the build would have failed, or at least warned -- some of the source files used Python 3 only code constructs since that commit removed Python 2 support, but they were blindly ignored and generated empty docs.

This may well be an upstream Sphinx bug, but I'd also expect this to happen more often in the future as more projects move away from Python 2. But this was also done with no configuration file, so everything default.

Actual Result

The build passed with no warnings.

@stsewd
Copy link
Member

stsewd commented Jan 13, 2020

You can actually see warning in the sphinx build step

Screenshot_2020-01-13 PyGithub Read the Docs

We want to improve that #4226

@stsewd stsewd added the Support Support question label Jan 13, 2020
@stsewd stsewd added the Needed: more information A reply from issue author is required label Jan 23, 2020
@no-response
Copy link

no-response bot commented Feb 6, 2020

This issue has been automatically closed because there has been no response to our request for more information from the original author. With only the information that is currently in the issue, we don't have enough information to take action. Please reach out if you have or find the answers we need so that we can investigate further. Thanks!

@no-response no-response bot closed this as completed Feb 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: more information A reply from issue author is required Support Support question
Projects
None yet
Development

No branches or pull requests

2 participants