Skip to content

Major updates to ESO documentation #3542

Draft
ashleythomasbarnes wants to merge 8 commits intoastropy:mainfrom
eso:develop-docs
Draft

Major updates to ESO documentation #3542
ashleythomasbarnes wants to merge 8 commits intoastropy:mainfrom
eso:develop-docs

Conversation

@ashleythomasbarnes
Copy link
Contributor

Summary of changes

  • Restructured and significantly expanded docs/eso for improved clarity and navigation.
  • Documented the new catalogue functionality within the ESO section.
  • Updated docs/index to include ESO in the catalogue services list.
  • Updated CHANGES.rst accordingly.

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.

@bsipocz
Copy link
Member

bsipocz commented Feb 27, 2026

A rendered HTML preview is attached for convenience:
astroquery-docs-html 5 (1).zip

No need for attaching this, the RTD link above should include a docs rendering.

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Basic Usage
===========

.. doctest-skip::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't skip testing the examples. The only ones that can/should be skipped are the ones accessing data behind authorization, etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted! Updating now...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@bsipocz bsipocz marked this pull request as draft February 27, 2026 20:51
@codecov
Copy link

codecov bot commented Feb 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.66%. Comparing base (b1cae75) to head (90a5c37).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ashleythomasbarnes
Copy link
Contributor Author

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?

@bsipocz
Copy link
Member

bsipocz commented Mar 4, 2026

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants