search

NREL / bifacial_radiance

Toolkit for working with RADIANCE for the ray-trace modeling of Bifacial Photovoltaics
https://bifacial-radiance.readthedocs.io
BSD 3-Clause "New" or "Revised" License
89 stars 48 forks source link

Update Documentation ReadtheDocs #434

Closed shirubana closed 1 year ago

shirubana commented 2 years ago

[x] Set thumbnails for the gallery: https://nbsphinx.readthedocs.io/en/0.8.9/subdir/gallery.html

[ ] Fix RTD build log warnings like CRITICAL. ie. Title level inconsistent:, and the notebooks are rendered strangely sometimes. This is because nbsphinx wants the title depth to only go down by one, e.g. # Big title only followed by ## Medium title, not ### Little title. So someone should go through the notebooks and make the titles only go down by one at a time.

[ ] May want to rename the notebooks to have shorter titles; some of them get a little cut off in the gallery page because they are so long.

shirubana commented 1 year ago

Clarify on Install Documentation: add Radiance to the system variables, not the user variables

cdeline commented 1 year ago

I have mine on User variables - it works still...

shirubana commented 1 year ago

ok. there was an user I helped that that was their issue, perhaps it was an isolated case

cdeline commented 1 year ago

@shirubana item 1 (nbgallery thumbnails) should be fixed by #440 already. item 2 (Sphinx errors) is a weird one, those only just now started showing up for me. Item 3 shorter notebook names I leave to you..

shirubana commented 1 year ago

I can do Item 2 and 3, part of the same thing...

shirubana commented 1 year ago

Sorry, Which branch should I use for this?

cdeline commented 1 year ago

New branch: 434_notebooks The errors may be stemming from this: https://github.com/spatialaudio/nbsphinx/issues/22#issuecomment-188890119