SuperDARN / rst

Radar Software Toolkit (RST)
https://superdarn.github.io/rst/
GNU General Public License v3.0
21 stars 16 forks source link

RTD needs a configuration file #601

Open aburrell opened 8 months ago

aburrell commented 8 months ago

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

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