Closed robertdstein closed 6 months ago
Changes Missing Coverage | Covered Lines | Changed/Added Lines | % | ||
---|---|---|---|---|---|
mirar/utils/docs/init.py | 0 | 2 | 0.0% | ||
mirar/utils/docs/pipeline_visualisation.py | 0 | 7 | 0.0% | ||
mirar/utils/docs/auto_config_docs.py | 0 | 69 | 0.0% | ||
<!-- | Total: | 0 | 78 | 0.0% | --> |
Files with Coverage Reduction | New Missed Lines | % | ||
---|---|---|---|---|
mirar/processors/utils/image_selector.py | 1 | 98.91% | ||
mirar/processors/sources/parquet_writer.py | 1 | 50.0% | ||
mirar/processors/sources/source_loader.py | 1 | 56.25% | ||
mirar/processors/sources/csv_exporter.py | 1 | 50.0% | ||
mirar/processors/utils/cal_hunter.py | 2 | 83.84% | ||
mirar/processors/reference.py | 2 | 89.81% | ||
<!-- | Total: | 8 | --> |
Totals | |
---|---|
Change from base Build 9136376719: | -1.0% |
Covered Lines: | 10888 |
Relevant Lines: | 13020 |
This PR fixes a problem that readthedocs cannot clone mirar, since the repo is too big.
Previously docs had to be updated manually. This PR removes all autogenerated sphinx rst files from git. It also removes all pipeline config pngs from git. That substantially reduces the size of cloning the repo (by ~half).
This PR now uses readthedocs to actually build the autogenerated docs, rather than requiring a person to run:
It also adds a new innovation: Generating and displaying the pipeline visualisations in readthedocs. Now you can view the current version of every pipeline config on readthedocs, and it'll be dynamically updated with each commit/PR.