gammapy / gamma-cat

An open data collection and source catalog for gamma-ray astronomy
https://gamma-cat.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
15 stars 17 forks source link

Fixup conf.py #176

Closed pdeiml closed 6 years ago

pdeiml commented 6 years ago

You can not access data on RTD, e.g. here https://gamma-cat.readthedocs.io/data/sources/source_2.html Clicking on the link to the data will lead to a non existing file.

I am not an expert on RTD and sphinx but I think the lines I changed are wrong. Locally, it is enough to run 'make.py clean', then 'make.py webpage', followed by 'make html' in the documentation folder. Hence, in the conf.py, it is not necessary to run 'make.py all' and the 'clean' and 'webpage' commands do not need the two hyphen. @cdeil Please check whether it is working now (and if not, please fix it in some way)

cdeil commented 6 years ago

@pdeiml - This is not the right fix, it will give the same result.

The way RTD works is that the HTML build output folder documentation/_build/html and only that folder get copied to a webserver and served. Currently there is a broken link because at https://github.com/gammapy/gamma-cat/blob/e570eaefc1cb05ea2e4d5beddcc1f0801873010a/documentation/templates/source_detail.txt#L15 you are linking to some other folder on the build machine. Since locally you use the same machine for building and serving the webpage it works, but not on RTD.

What we have to do is to put a copy of the output folder into documentation/_build/html, and link to the files there. @pdeiml - Do you want to try and change the scripts and line in the template I linked to above to do that? If you can't get it to work, assign the issue or pull request over to me and I'll try to find time to do it soon.

pdeiml commented 6 years ago

I will try to fix it this week