nanograv / enterprise

ENTERPRISE (Enhanced Numerical Toolbox Enabling a Robust PulsaR Inference SuitE) is a pulsar timing analysis code, aimed at noise analysis, gravitational-wave searches, and timing model analysis.
https://enterprise.readthedocs.io
MIT License
67 stars 67 forks source link

Added a .readthedocs.yaml config file for Enterprise #360

Closed vhaasteren closed 1 year ago

vhaasteren commented 1 year ago

This one solves #357 by adding a ReadTheDocs configuration file .readthedocs.yaml in the root directory. As of now, RTD requires that, and the CI tests fail here on github.

The content of the config file is below. It's just the default one would use for this kind of setup. Also added a requirements.txt for the docs building, which uses a theme.

# .readthedocs.yaml
version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.10"

sphinx:
  configuration: docs/conf.py
python:
  install:
    - requirements: docs/requirements.txt
codecov[bot] commented 1 year ago

Codecov Report

Merging #360 (7fb147f) into master (257cf2f) will not change coverage. The diff coverage is n/a.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/nanograv/enterprise/pull/360/graphs/tree.svg?width=650&height=150&src=pr&token=7Sjk8cLA85&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv)](https://app.codecov.io/gh/nanograv/enterprise/pull/360?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv) ```diff @@ Coverage Diff @@ ## master #360 +/- ## ======================================= Coverage 88.37% 88.37% ======================================= Files 13 13 Lines 3012 3012 ======================================= Hits 2662 2662 Misses 350 350 ``` ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/nanograv/enterprise/pull/360?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/nanograv/enterprise/pull/360?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv). Last update [257cf2f...7fb147f](https://app.codecov.io/gh/nanograv/enterprise/pull/360?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=nanograv).
vhaasteren commented 1 year ago

@AaronDJohnson, this PR will fix the codecov errors in all the other open PRs, so let's merge this one to main if you approve.