igmhub / LaCE

Emulator for the one-dimensional Lyman-alpha flux power spectrum. It was used to generate the results shown in https://arxiv.org/abs/2011.15127, https://arxiv.org/abs/2209.09895, and https://arxiv.org/abs/2305.19064.
1 stars 3 forks source link

Readthedocs #102

Closed lauracabayol closed 3 months ago

lauracabayol commented 3 months ago

This branch includes a new folder 'docs' with the required files to create a readthedocs documentation for LaCE. There are many commits and modified files, but most of them are either new or modifying the docstrings.

The only file that I have modified a line of code is the function get_attrs in the Nyxarchive. For convenience in the documentation, I have added it inside the archive class.

I have tested that the archive loads correctly, and everything seems correct. I have checked and I think the function is not used anywhere else, but @jchavesmontero please confirm.

The documentation it generates is https://lace-p1d.readthedocs.io/en/latest/ By now it generates it from this branch, I will change this in the configuration once merged.