search

kayak / pypika

PyPika is a python SQL query builder that exposes the full richness of the SQL language using a syntax that reflects the resulting query. PyPika excels at all sorts of SQL queries but is especially useful for data analysis.
http://pypika.readthedocs.io/en/latest/
Apache License 2.0
2.43k stars 292 forks source link

Set up documentation automation #780

Open wd60622 opened 6 months ago

wd60622 commented 6 months ago

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 ?

AzisK commented 6 months ago

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

wd60622 commented 6 months ago

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?