search

twisted / pydoctor

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

Outline diff to sphinx in context of automation level #791

Closed buhtz closed 4 months ago

buhtz commented 4 months ago

Accidentally discovered this FAQ section.

Correct me if I am wrong but I often tried Sphinx* in the past and was not able to auto-generated documentation based on source files. You always need a rst file.

tristanlatr commented 4 months ago

Correct me if I am wrong but I often tried Sphinx* in the past and was not able to auto-generated documentation based on source files. You always need a rst file.

There are automated tools that are able to generate rst files from source code files, like sphinx-autoapi.

buhtz commented 4 months ago

Correct me if I am wrong but I often tried Sphinx* in the past and was not able to auto-generated documentation based on source files. You always need a rst file.

There are automated tools that are able to generate rst files from source code files, like sphinx-autoapi.

I never got them work. The point is that it is not Sphinx but a Sphinx extension. It is a workaround to make Sphinx do something that it was not invented for.

No matter if it is possible or not the point of comparing pydoctor with sphinx is that it is easy with pydoctor without using a config file or any in-between-file-format or an extension. PyDoctor is for API documentation and Sphinx is not.

codecov[bot] commented 4 months ago

Codecov Report

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

Project coverage is 92.60%. Comparing base (e03b43e) to head (225c2be). Report is 1 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #791 +/- ## ======================================= Coverage 92.60% 92.60% ======================================= Files 47 47 Lines 8389 8389 Branches 1850 1850 ======================================= Hits 7769 7769 Misses 356 356 Partials 264 264 ```

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