New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc: Cross link to API reference page from Operators page #1383

Closed

kaxil opened this issue Dec 7, 2022 · 0 comments · Fixed by #1401

Assignees

Labels

documentation product/python-sdk

Milestone

Collaborator

kaxil commented Dec 7, 2022

Currently there is no way to jump to Func/Operator definition from https://astro-sdk-python.readthedocs.io/en/stable/astro/sql/operators/get_value_list.html (and other operators listed on https://astro-sdk-python.readthedocs.io/en/stable/guides/operators.html) to their definition https://astro-sdk-python.readthedocs.io/en/stable/autoapi/index.html

We should cross-link them using https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-syntax

kaxil added documentation product/python-sdk labels

kaxil added this to the 1.3.1 milestone

phanikumv assigned rajaths010494

rajaths010494 mentioned this issue

Doc: Cross link to API reference page from Operators page #1401

Merged

sunank200 closed this as completed in #1401

sunank200 pushed a commit that referenced this issue


          Doc: Cross link to API reference page from Operators page (#1401)

3a71e94

Currently there is no way to jump to Func/Operator definition from
https://astro-sdk-python.readthedocs.io/en/stable/astro/sql/operators/get_value_list.html
(and other operators listed on
https://astro-sdk-python.readthedocs.io/en/stable/guides/operators.html)
to their definition
https://astro-sdk-python.readthedocs.io/en/stable/autoapi/index.html

We should cross-link them using
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-syntax

closes #1383

kaxil pushed a commit that referenced this issue


          Doc: Cross link to API reference page from Operators page (#1401)

831f860

Currently there is no way to jump to Func/Operator definition from
https://astro-sdk-python.readthedocs.io/en/stable/astro/sql/operators/get_value_list.html
(and other operators listed on
https://astro-sdk-python.readthedocs.io/en/stable/guides/operators.html)
to their definition
https://astro-sdk-python.readthedocs.io/en/stable/autoapi/index.html

We should cross-link them using
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-syntax

closes #1383

(cherry picked from commit 3a71e94)

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