search

SnowEx / snowexsql

A project to access the SnowEx database holding data from the NASA SnowEx campaign
https://snowexsql.readthedocs.io/en/latest/readme.html
GNU General Public License v3.0
23 stars 6 forks source link

Revisit docs #91

Closed jomey closed 1 month ago

jomey commented 1 month ago

This is an effort to consolidate the different development setup instructions we had and centralize them to be all in the /docs folder. Also adds more content to the contributing guide and adds that to the root level of the repository.

Addresses the last item and closes #88

jomey commented 1 month ago

The local gallery extensions is currently breaking the build on ReadTheDocs.io

Couldn't find a solution and this what I have researched so far:

The `local_extensions` key in the config.yaml only works when using the
'jb build book' command. Deploying on 'ReadTheDocs' however uses the
'jb config sphinx' command, which ignores that (currently). Trying a 
workaround to set the PYTHONPATH manually before executing the build
did not work.
jomey commented 1 month ago

Decided to roll back to a manual build of the gallery using the Jupyter Book Card feature. This not ideal, but lets us build and roll out the updates.

CC: @aaarendt