search

GraylinKim / sc2reader

A python library that extracts data from various Starcraft II resources to power tools and services for the SC2 community. Who doesn't want to hack on the games they play?
http://sc2reader.readthedocs.org
MIT License
413 stars 85 forks source link

Autodocs are borked #77

Closed wraithan closed 11 years ago

wraithan commented 12 years ago

Recent build on ReadTheDocs shows that there is a file missing. Specifically the file that one of the python files in your app is trying to load is sc2reader/data/16939_units.csv.

Because AutoDoc is hitting this it means you load this file in the top level of a python file. I'd recommend against that in general, both because it is a side effect of loading the module (bad) and hitting the disk more than need (bad)

GraylinKim commented 12 years ago

Yeah, I was actually already aware of this but haven't had the time to chase it down. The docs work fine if you build them from your local computer so I'm really not sure what is going on. Can you explain what you mean when you say:

Because AutoDoc is hitting this it means you load this file in the top level of a python file.

The current approach was meant to be temporary and will be replaced when I complete HotS support. Do you have recommendations for a good format to compile the data into?

GraylinKim commented 11 years ago

Fixed by 80f0507. Distributing packages with data files does not work how I thought it did.