microsoft / torchgeo

TorchGeo: datasets, samplers, transforms, and pre-trained models for geospatial data
https://www.osgeo.org/projects/torchgeo/
MIT License
2.74k stars 341 forks source link

Change documentation theme #2006

Open adamjstewart opened 6 months ago

adamjstewart commented 6 months ago

Issue

We've been using pytorch-sphinx-theme since the start of the project, but it contains a number of known issues and is barely maintained. We should consider switching to a modern theme with fewer bugs and better support.

Fix

I was originally planning on using trojanzoo-sphinx-theme but it looks like this is also unmaintained now. I don't think I have the skills or expertise to maintain my own fork of either. We should look into popular themes and choose one that looks cool. Can people propose themes and link to examples on this issue?

adamjstewart commented 5 months ago

PyTorch Lightning uses a fork of pytorch-sphinx-theme called lightning-sphinx-theme. However, this fork seems to have some of the same problems (no PyPI releases).