pypika icon indicating copy to clipboard operation
pypika copied to clipboard

Set up documentation automation

Open wd60622 opened this issue 8 months ago • 2 comments

There have been a few recent changes to the document. However, there is no set process to have them updated. Based on the read the docs page, it seems the haven't been updated in 6 years.

I think it would be good to automate this in order to reduce manual tasks while also keeping items up to date

Any thoughts here @AzisK @twheys ?

wd60622 avatar Dec 10 '23 14:12 wd60622

I don't really have an idea how to do it unless somehow connect tests to documentation and then generate the documentation based on the tests

AzisK avatar Dec 10 '23 17:12 AzisK

I don't really have an idea how to do it unless somehow connect tests to documentation and then generate the documentation based on the tests

I mean, the documentation would be built off the main branch which would pass all previous requirements including tests so I don't see how quality is much of a concern

Do you think an action after merge to main (passing PRs and all) would solve your concern?

wd60622 avatar Dec 10 '23 18:12 wd60622