-
Notifications
You must be signed in to change notification settings - Fork 51
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
Sphinx may not generate an api folder #799
base: master
Are you sure you want to change the base?
Conversation
Fix a bug for simple projects where sphinx does not generate a docs/build/html/api/ folder. Without this fix the rename fails because the output_path does not exist.
Hi David, Thanks for the PR. Can you please add more details about this use case? Why is Sphinx not generating the API sub-folder ? If Sphinx is not generating the API sub-folder, it looks like you are not using the pydoctor extension as designed. If this is a valid use case, we also need documentation and automated test for this to make sure this feature is supported in future versions. Regards |
Hello, this seems related to #728, which I cannot figure out! So if this check fixes the issue I’m very very happy. Did you find a minimal reproducer for this issue ? We should really have a test for this, would it possible to add it ? Thanks a lot. |
You can check the pr #742 in which I added some sphinx extension test in the hope to find a reproducer but I did not managed. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #799 +/- ##
==========================================
- Coverage 92.62% 92.56% -0.06%
==========================================
Files 47 47
Lines 8393 8393
Branches 1850 1850
==========================================
- Hits 7774 7769 -5
- Misses 356 359 +3
- Partials 263 265 +2 ☔ View full report in Codecov by Sentry. |
Hi @lod, did you managed to get an actual reproducer for that issue? |
Hello @lod, have you been able to pin point why Sphinx might not generate the api folder? |
Trivial fix for a bug with simple projects where sphinx does not generate a docs/build/html/api/ folder. Without this fix the rename fails because the output_path does not exist.