search

cabouman / mbircone

BSD 3-Clause "New" or "Revised" License
11 stars 9 forks source link

Add dask to docs requirements. #48

Closed DamonLee5 closed 2 years ago

DamonLee5 commented 2 years ago

We want to generate API webpages on readthedocs. Previously, we got empty webpages and now I make a fix for it.

The fix may need Prof. Bouman's help.

  1. Enable the option Install Project under Admin -> Advanced Settings on readthedocs as shown in the above figure. I highlight the section, Prof. Bouman @cabouman can try to enable the option.

readthedoc_setup

  1. To ensure readthedocs can build all API references(cone3D, mace, multinode), I add required packages to docs/requirements.txt in this PR.

Here is the built webpage for API reference. https://mbircone-wenrui.readthedocs.io/en/latest/cone3D.html I fork mbircone to my own account and tested it on readthedocs.

cabouman commented 2 years ago

Wenrui, I just made the requested change.

cabouman commented 2 years ago

I'm going to accept this PR, so we can move ahead.