astropy / saba

A Package which allows astropy to interface with sherpa
GNU General Public License v3.0
8 stars 9 forks source link

Documentation updates #3

Closed taldcroft closed 8 years ago

taldcroft commented 8 years ago

I had a go at cleaning up the docs and making them a more organizationally consistent with astropy.

taldcroft commented 8 years ago

BTW, I am not a sphinx expert but I don't think that the generated plots should live in docs/_generated in the repo. If you go into docs and do make clean (which should be a fine thing) then they get wiped. In astropy (e.g. https://github.com/astropy/astropy/tree/master/docs/time) generated PNGs are just there in the docs directory.

taldcroft commented 8 years ago

Also the sphinx_build generates some ugly warnings about code for me. This should be cleaned up.

nocturnalastro commented 8 years ago

Thanks @taldcroft It looks alot better now I'll have a look at the build warnings and moving the generated images