spacetelescope / repostats

Creates a sortable HTML table that contains a summary of all the repositories for the specified GitHub organization
BSD 3-Clause "New" or "Revised" License
2 stars 4 forks source link

Bug: Doc build status inaccurate when RTD name is different from repo name #15

Closed pllim closed 6 years ago

pllim commented 6 years ago

For synphot_refactor, the RTD is http://synphot.readthedocs.io/en/latest/

For stsynphot_refactor, the RTD is http://stsynphot.readthedocs.io/en/latest/

Not sure how you can generalize this fix. Case-by-case exception is fine by me. Sorry for the inconvenience.

sosey commented 6 years ago

I think since this is hard to generalize, we could return an explicit string that says see the repository, or just leave it as the docs-unknown icon, either is a heads up to look at the repository itself.

pllim commented 6 years ago

No way I can insert some exception rules just for these two?

sosey commented 6 years ago

if you're willing to look through all the repositories, note which ones don't point to docs not with the same name of the repo, and lists where they should point instead, and then submit a PR that deals with this, I'll happily accept. More generally it should probably be a separate function that pulls the readme file for repo and scrapes for the badge locations to rtd

pllim commented 6 years ago

Badge scraping works for me!

sosey commented 6 years ago

excellent, I look forward to your PR then ;)

pllim commented 6 years ago

Wait... That is not what I meant... :sweat_smile: