search

twisted / pydoctor

This is pydoctor, an API documentation generator that works by static analysis.
https://pydoctor.readthedocs.io/
Other
179 stars 47 forks source link

Sphinx may not generate an api folder #799

Open lod opened 2 weeks ago

lod commented 2 weeks ago

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.

adiroiban commented 2 weeks ago

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

tristanlatr commented 2 weeks ago

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.

tristanlatr commented 2 weeks ago

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[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.56%. Comparing base (dca9625) to head (21ca88c).

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.