Major updates to ESO documentation #3542
Major updates to ESO documentation #3542ashleythomasbarnes wants to merge 8 commits intoastropy:mainfrom
Conversation
No need for attaching this, the RTD link above should include a docs rendering. |
bsipocz
left a comment
There was a problem hiding this comment.
Since all the tests and docs build are failing I would switch this to a draft PR for now and we come back with a review once at least the RTD build is successful
docs/eso/eso_cat_tap.rst
Outdated
| Basic Usage | ||
| =========== | ||
|
|
||
| .. doctest-skip:: |
There was a problem hiding this comment.
Please don't skip testing the examples. The only ones that can/should be skipped are the ones accessing data behind authorization, etc.
There was a problem hiding this comment.
Noted! Updating now...
There was a problem hiding this comment.
I think I have to do this here though, otherwise I get the error:
______________________________ [doctest] eso.rst _______________________________
023 and show how to download the corresponding data products.
024
025 .. doctest-remote-data::
026
027 >>> from astroquery.eso import Eso
028 >>> eso = Eso()
029
030 >>> from astropy.coordinates import SkyCoord
031 >>> import astropy.units as u
032 >>> coords = SkyCoord.from_name("HD 37903")
UNEXPECTED EXCEPTION: NameResolveError('All Sesame queries failed. Unable to retrieve coordinates. See errors per URL below: \n https://cds.unistra.fr/cgi-bin/nph-sesame/SNV?HD%2037903: An attempt was made to connect to the internet by a test that was not marked remote_data. The requested host was: cds.unistra.fr\nhttp://vizier.cfa.harvard.edu/viz-bin/nph-sesame/SNV?HD%2037903: An attempt was made to connect to the internet by a test that was not marked remote_data. The requested host was: vizier.cfa.harvard.edu')
Traceback (most recent call last):
File "<doctest eso.rst[4]>", line 1, in
File "/home/runner/work/astroquery/astroquery/.tox/py314-test/lib/python3.14/site-packages/astropy/coordinates/sky_coordinate.py", line 1865, in from_name
icrs_coord = get_icrs_coordinates(name, parse, cache=cache)
File "/home/runner/work/astroquery/astroquery/.tox/py314-test/lib/python3.14/site-packages/astropy/coordinates/name_resolve.py", line 196, in get_icrs_coordinates
raise NameResolveError(
...<2 lines>...
)
astropy.coordinates.name_resolve.NameResolveError: All Sesame queries failed. Unable to retrieve coordinates. See errors per URL below:
https://cds.unistra.fr/cgi-bin/nph-sesame/SNV?HD%2037903: An attempt was made to connect to the internet by a test that was not marked remote_data. The requested host was: cds.unistra.fr
http://vizier.cfa.harvard.edu/viz-bin/nph-sesame/SNV?HD%2037903: An attempt was made to connect to the internet by a test that was not marked remote_data. The requested host was: vizier.cfa.harvard.edu
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3542 +/- ##
=======================================
Coverage 72.66% 72.66%
=======================================
Files 219 219
Lines 20480 20480
=======================================
Hits 14882 14882
Misses 5598 5598 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
* Updated docs/eso and docs/eso with overhaul with now also catalogues * Update CHANGES.rst
00b2189 to
317bfee
Compare
|
Seems like all checks are now passing, apart from actually building the docs as the catalogue functionality isn't in astroquery yet (and it appears to be looking for this). @bsipocz - could you advise how to proceed? |
We need to get that PR in first and then adjust this one as necessary. |
Summary of changes
A rendered HTML preview is attached for convenience:
astroquery-docs-html 5 (1).zip
These documentation updates have been reviewed by @juanmcloaiza and @almicol over multiple iterations.