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

Fix IRDB on ReadTheDocs #131

Open
hugobuddel opened this issue Aug 21, 2023 · 0 comments
Open

Fix IRDB on ReadTheDocs #131

hugobuddel opened this issue Aug 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hugobuddel
Copy link
Collaborator

The read the docs documentations for the IRDB currently fails to build.

This is probably because the job building the documentation simply takes too long and/or runs out of memory. My proposal is to add the same USE_FULL_DETECTOR hack to .readthedocs.yaml as is used for the github test runner for now (however, I don't know how to do that):

sed -i "s/USE_FULL_DETECTOR = True/USE_FULL_DETECTOR = False/g" MICADO/docs/example_notebooks/*.ipynb

Then later we can remove that hack once we made ScopeSim fast again.

Difficulty is that we don't have access to our readthedocs account. A workaround is to manually import the IRDB as a personal project on rtd. In that project it will be possible to see what the problem is, and if those are fixed, then the official documentation is also fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants