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

Build infrastructure: Run ReadTheDocs on every PR/commit? #759

Closed buhtz closed 6 months ago

buhtz commented 6 months ago

I am not sure but it seems to me that ReadTheDocs (RTD) build the docu on every PR and commit in this PR:

IMHO this makes not much sense because that docu instance is related just to this commit and temporary branch. It is not the main docu read by the users.

Disabling this would save CO2 and other resources on the site of RTD.

buhtz commented 6 months ago

Maybe trigger the build only when merging into the dev branch? I assume "dev branch" is main in your case.

btw: Brings me to the point that explaining the "branching model" should be part of the contribution docu, too.

tristanlatr commented 6 months ago

We do not have such a thing as the dev branch. The master branch is our trunk and we cut releases from it a couple times a year.

The read the docs should be run on every PR, this way we can have the rendered documentation for every PR. Yes it consume ressources but it’s designed to be like this.