search

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

Update reference detail on RTD #225

Closed pdeiml closed 6 years ago

pdeiml commented 6 years ago

This PR consists of three additions to the reference detail pages on RTD:

1) https://github.com/gammapy/gamma-cat/commit/43c7ab89a2090e9891457384712be7c69cc96cb4 adds the github input- and output folder to the list of basic information .

2) https://github.com/gammapy/gamma-cat/commit/f45cc6c60328f8f8d31b495638fc69a0f9539161 adds all GammaCat resources (dataset, sed, lc) stored in the output collection to the subsection 'Resources'.

3) https://github.com/gammapy/gamma-cat/commit/0815ce5385958e05c68efd0fd956a1c20b09096d adds the data entry status and the review status to the list of basic information.

The way the third change is implemented looks a little bit ugly and might need a bit clean up but for now it works and therefore it should be merged.

The diff is being very large because this PR is on top of https://github.com/gammapy/gamma-cat/pull/224. Hence, if https://github.com/gammapy/gamma-cat/pull/224 is merged the diff of this PR will be sweet and small :-)

RTM (after merge of https://github.com/gammapy/gamma-cat/pull/224)

pdeiml commented 6 years ago

I might need to do a rebase after https://github.com/gammapy/gamma-cat/pull/224 is merged. But if not and there are no merge conflicts, this PR is ready to merge :-)

pdeiml commented 6 years ago

I cleaned up the lines your inline comment referes to. But I added a inline comment as well and please read it before merging.

cdeil commented 6 years ago

To be honest, I'm not sure if I'll find time to do a detailed review / improvements to this code next week also ...

@pdeiml - I'm merging this now, trying it out locally.

cdeil commented 6 years ago

I checked one example: http://gamma-cat.readthedocs.io/data/references/2009ApJ...705.1624A.html

It looks good, but the following links are broken:

Edit on github: input/data/2009/2009ApJ…705.1624A Catalog data on github: output/data/2009/2009ApJ…705.1624A

https://github.com/gammapy/gamma-cat/blob/master/input/data/%7B'2009'%7D/2009ApJ...705.1624A https://github.com/gammapy/gamma-cat/blob/master/output/data/%7B'2009'%7D/2009ApJ...705.1624A

@pdeiml - You should see the same issue if you try this webpage locally. Can you please fix in a follow-up PR?