Skip to content

Updating and Editing AstroDB Documentation#216

Closed
lesliech1004 wants to merge 15 commits intoastrodbtoolkit:mainfrom
lesliech1004:doc_updates
Closed

Updating and Editing AstroDB Documentation#216
lesliech1004 wants to merge 15 commits intoastrodbtoolkit:mainfrom
lesliech1004:doc_updates

Conversation

@lesliech1004
Copy link
Copy Markdown
Contributor

No description provided.

Added description for get_db_instrument.
Added an instruments section on api documentation
Added a code block example for ingesting publications.
@lesliech1004 lesliech1004 marked this pull request as draft November 27, 2025 01:12
Comment thread docs/pages/ingesting/ingesting_publications.rst Outdated
Comment thread docs/pages/querying_existing_db/querying.rst Outdated
Comment thread docs/pages/ingesting/ingesting_publications.rst Outdated
Comment thread docs/pages/ingesting/ingesting_publications.rst Outdated
Comment thread docs/pages/querying_existing_db/querying.rst Outdated
Comment thread docs/pages/querying_existing_db/querying.rst Outdated
Comment thread docs/pages/querying_existing_db/querying.rst Outdated
lesliech1004 and others added 5 commits December 9, 2025 11:23
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
@kelle
Copy link
Copy Markdown
Contributor

kelle commented Dec 9, 2025

The tests not passing are not related to this PR.

This is coming along nicely! When you're done, change from Draft to "Ready for review".

Comment thread docs/pages/querying_existing_db/querying.rst Outdated
Comment thread docs/pages/querying_existing_db/querying.rst Outdated
Comment thread docs/pages/querying_existing_db/querying.rst
Comment thread docs/pages/querying_existing_db/querying.rst
Comment thread docs/pages/querying_existing_db/querying.rst
@kelle
Copy link
Copy Markdown
Contributor

kelle commented Dec 9, 2025

Please make extensive use of the :py:func directive when referring to functions and :py:meth: to link to methods. For example,

:py:func:`find publication <astrodb_utils.publications.find_publication>`

will make an auto-magic link to the API documentation for the find_publication function.

Here's the relevant Sphinx documentation: https://www.sphinx-doc.org/en/master/usage/domains/python.html#target-specification

dr-rodriguez and others added 2 commits January 27, 2026 15:43
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
@kelle kelle marked this pull request as ready for review January 27, 2026 20:44
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
@kelle
Copy link
Copy Markdown
Contributor

kelle commented Jan 27, 2026

Replaced by #230

@kelle kelle closed this Jan 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants