Skip to content
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

Close #5977: :var: field do not create a cross-reference … #8638

Merged
merged 2 commits into from Jan 5, 2021
Merged

Close #5977: :var: field do not create a cross-reference … #8638

merged 2 commits into from Jan 5, 2021

Commits on Jan 1, 2021

  1. test: py domain: Add a testcase for :var: field

    @tk0miya
    tk0miya committed Jan 1, 2021
    Configuration menu
    Copy the full SHA
    9cac200 View commit details
    Browse the repository at this point in the history

  2. Close sphinx-doc#5977: :var: field do not create a cross-reference 

    Since its beginning, `:var:` field has created a cross-reference to the
attribute having the same name.  It is meaningful only if the attribute
is documented by `py:attribute` directive.  It means the `:var:` field
and `:attr:` role are almost the same and conflicted.  Additionally,
the cross-reference points incorrect variable if the target is not
documented.

Thus, the cross-reference feature of `:var:` field is disabled.
    @tk0miya
    tk0miya committed Jan 1, 2021
    Configuration menu
    Copy the full SHA
    918086b View commit details
    Browse the repository at this point in the history