search

NREL / Panel-Segmentation

This open-source package provides a framework for automatically detecting and extracting metadata from solar array installations in satellite images.
https://panel-segmentation.readthedocs.io
MIT License
21 stars 5 forks source link

Set up readthedocs #4

Closed kandersolar closed 3 years ago

kandersolar commented 3 years ago

Using the same (questionable) package dependencies from #3 here just so that the package installs successfully on RTD.

I'm configuring latest to track master and stable to track the latest non-pre-release tag, with stable being the default.

kandersolar commented 3 years ago

@kperrynrel I also configured RTD to do unofficial PR builds as another CI check; here's the one for this PR: https://panel-segmentation--4.org.readthedocs.build/en/4/index.html

Between the fixes here and in #1, most of the rendering issues are fixed at this point. There are a few build warnings that would be nice to fix but don't affect the rendered docs, so I might follow this up with another PR for those and some additional minor cleanup.

What do you think about integrating your example notebooks into the sphinx docs? It's pretty easy to use notebooks as the source code for pages like this rdtools example page, and I recently discovered you can create an example gallery from notebooks too like this test PR for rdtools. Happy to add that here if you think that's a good idea.

kperrynrel commented 3 years ago

@kanderso this looks great. I requested a review--I'm gonna try a pip install on this, and troubleshoot if we have any issues on running the jupyter notebooks. Thank you so much for your help!

kperrynrel commented 3 years ago

Tested package with pip install in a fresh conda environment. Looks good, merging this.