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

Improve documentation on RTD, especially for METIS #162

Open
7 tasks
teutoburg opened this issue Mar 11, 2024 · 3 comments
Open
7 tasks

Improve documentation on RTD, especially for METIS #162

teutoburg opened this issue Mar 11, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@teutoburg
Copy link
Contributor

teutoburg commented Mar 11, 2024

This should be ready in time for the METIS science team meeting.

  • Improve the look and feel of the IRDB RTD site.
  • Make sure all notebooks are included (e.g. IFU).
  • Make sure all notebooks are run, i.e. there is actually output shown on RTD.
  • Make sure all information is correct / up to date.
  • Check Fix IRDB on ReadTheDocs #131
  • Generally reconsider RTD structure, it's currently limited to METIS and MICADO.
  • Move to a pyproject.toml-based build, rather than the current obnoxious requirements.readthedocs.txt.
@teutoburg teutoburg added the documentation Improvements or additions to documentation label Mar 11, 2024
@teutoburg teutoburg self-assigned this Mar 11, 2024
@teutoburg teutoburg moved this from 🆕 New to 🏗 In progress in ScopeSim-development Mar 11, 2024
@hugobuddel
Copy link
Collaborator

The notebooks probably cannot be ran on RTD itself, as they probably require too much RAM. But for METIS we can try to do everything on RTD; MICADO is more problematic IIRC. In the long run it might be better to build the documentation on zeus and then upload it to RTD, assuming that is possible.

@teutoburg
Copy link
Contributor Author

The notebooks probably cannot be ran on RTD itself, as they probably require too much RAM.

Correct. I already expected that, but tried it anyway to see what happens, and I got a "Build cancelled for excessive memory usage.". According to RTD, they provide a maximum of 3 GB (and 15 min execution time) for the free version.

@teutoburg
Copy link
Contributor Author

In the long run it might be better to build the documentation on zeus and then upload it to RTD, assuming that is possible.

Yeah, that was my thought as well. I'd like to explore that option at some point in the not-too-distant future...

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: 🏗 In progress
Development

No branches or pull requests

2 participants