Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
Nov 6, 2023

Conversation

vhaasteren
Copy link
Member

@vhaasteren vhaasteren commented Sep 29, 2023

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
Copy link

codecov bot commented Sep 29, 2023

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

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 257cf2f...7fb147f. Read the comment docs.

@vhaasteren
Copy link
Member Author

@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.

@AaronDJohnson AaronDJohnson merged commit c49646c into nanograv:master Nov 6, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants