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

RTD needs a configuration file #601

Open
1 of 3 tasks
aburrell opened this issue Oct 4, 2023 · 0 comments
Open
1 of 3 tasks

RTD needs a configuration file #601

aburrell opened this issue Oct 4, 2023 · 0 comments

Comments

@aburrell
Copy link
Contributor

aburrell commented Oct 4, 2023

BUG

Read The Docs requires a configuration file to run tests now. This is a yaml file. This needs to be addressed by someone with admin privileges at RTDs.

Priority

  • Minor - typo, incorrect naming, fails in a specific uncommon situation
  • Major - misrepresentation of data, failure in a common situation
  • Urgent - failure in usage, large misrepresentation of data

RST version

Does the bug occur in an official RST release?
All GitHub branches

Example of the bug

please provide code and output of the bug

Attempts

What have you tried already to fix it?
I tried adding an appropriately named yaml based on other projects, but I don't know the details about the RST configuration needed to make it work.

What have you tried to work around it?
Current work around is to ignore this test failure

Data Access

Please describe how to obtain the data needed to reproduce the bug (e.g. specific file, use make_fit on any rawacf file).
Go to RTD.

Potential Bug Location

If possible, provide a link to the RST source code where you think the bug is coming from
Missing .readthedocs.yml file

Potential Solution(s)

If possible, provide suggestions on how to fix the bug
Add a .readthedocs.yml file

Extra Notes

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant