GreenScheduler / cats

CATS: the Climate-Aware Task Scheduler :cat2: :tiger2: :leopard:
https://greenscheduler.github.io/cats/
MIT License
47 stars 7 forks source link

docs: cli reference #60

Closed ljcolling closed 11 months ago

ljcolling commented 11 months ago

added cli arguments to docs

tlestang commented 11 months ago

Thanks, don't you need to pip install cats in the workflow? In case autodocs needs to import cats.__init__. I can see that's one of the reason the API reference isn't being generated (#59) by sphinx (plus the fact that module names are outdated after merging #49)

ljcolling commented 11 months ago

Thanks, don't you need to pip install cats

Ah yes you do. I'll update it

ljcolling commented 11 months ago

Ok, I think it should work as expected now

tlestang commented 11 months ago

Yes, I pushed your changes to my fork and built it from there: https://tlestang.github.io/cats/api-reference.html So anyone can have a look at the rendered version.