search

jackh726 / bigtools

A high-performance BigWig and BigBed library in Rust
MIT License
70 stars 7 forks source link

Readthedocs configuration #14

Closed nvictus closed 9 months ago

nvictus commented 9 months ago

Adds a readthedocs config that will cancel builds unless changes appear in the pybigtools folder.

When setting this up as a subproject in readthedocs, you will need to set the custom path of the config file as described here.

jackh726 commented 9 months ago

Hmm, this doesn't seem to work:

The keys build.jobs and build.commands can't be used together.

nvictus commented 9 months ago

I see. If build.commands overrides all pre-defined jobs (which I think is supposed to run sphinx or mkdocs), then maybe we just move the cancellation statement to build.commands

jackh726 commented 9 months ago

I was looking but didn't come up with an answer - do we then need to add the other commands that would be run by default (e.g. checkout)?

nvictus commented 9 months ago

From this example, I'm assuming no: https://github.com/readthedocs-examples/example-monorepo/blob/main/docusaurus/.readthedocs.yaml