Title: Doc: Fix `!` in C domain ref target syntax · Issue #97740 · python/cpython · GitHub
Open Graph Title: Doc: Fix `!` in C domain ref target syntax · Issue #97740 · python/cpython
X Title: Doc: Fix `!` in C domain ref target syntax · Issue #97740 · python/cpython
Description: ! doesn't appear to work as documented in the C domain (to not try to resolve references) in the CPython docs building on 4.5.0. That means there's no way to not link subsequent instances of a reference to a C domain item, or refer to an...
Open Graph Description: ! doesn't appear to work as documented in the C domain (to not try to resolve references) in the CPython docs building on 4.5.0. That means there's no way to not link subsequent instances of a refe...
X Description: ! doesn't appear to work as documented in the C domain (to not try to resolve references) in the CPython docs building on 4.5.0. That means there's no way to not link subsequent instances o...
Opengraph URL: https://github.com/python/cpython/issues/97740
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Doc: Fix `!` in C domain ref target syntax","articleBody":" `!` doesn't appear to work as documented in the C domain (to not try to resolve references) in the CPython docs building on 4.5.0. That means there's no way to not link subsequent instances of a reference to a C domain item, or refer to an item that isn't defined (e.g. for removed or undocumented APIs in the What's New, where it is used heavily) without either using the syntactically, semantically and stylistically inconsistent literal syntax (or, for non-existent entries, attempting to resolve known broken references and generating spurious warnings).\r\n\r\nThanks to @AA-Turner 's helpful investigation, it looks like this is:\r\n\r\n\u003e an implementation error in `CXRefRole.run()` means that if `c_allow_pre_v3` is `True` then the value of `.disabled` is ignored, hence the `!` is not taken into account.\r\n\r\nAt some point soon we need to upgrade the docs to the latest Sphinx to pick up a number of significant features and bug fixes that have been implemented specifically for our docs, and we also need to migrate off `c_allow_pre_v3` which I understand @AA-Turner is also working on. However, there is an immediate stopgap fix to get things working immediately, including on older docs—we can add a bit of code in our `conf.py` to avoid the issue. I'll submit a PR.","author":{"url":"https://github.com/CAM-Gerlach","@type":"Person","name":"CAM-Gerlach"},"datePublished":"2022-10-02T15:43:44.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/97740/cpython/issues/97740"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:d6de421b-0557-af7e-0652-0dded286e28a |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9606:22AEF5:DDF3A8:12D983E:69693CFE |
| html-safe-nonce | 1ed3ad3d34ab0bef31e70ffd09066a710a70174872065daf750629beae55d6ea |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5NjA2OjIyQUVGNTpEREYzQTg6MTJEOTgzRTo2OTY5M0NGRSIsInZpc2l0b3JfaWQiOiI0MTY0MjQ2NTI3ODQ1OTQwNDc4IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | c8f6f8b819868d6d2b8549a5f7b77049fd77435c41ca1db465375827f99cecdd |
| hovercard-subject-tag | issue:1393808039 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/cpython/97740/issue_layout |
| twitter:image | https://opengraph.githubassets.com/c72488dcc83bea149ea3b6526e8d9d44384122fae5a28b95206c30d208cab8ab/python/cpython/issues/97740 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/c72488dcc83bea149ea3b6526e8d9d44384122fae5a28b95206c30d208cab8ab/python/cpython/issues/97740 |
| og:image:alt | ! doesn't appear to work as documented in the C domain (to not try to resolve references) in the CPython docs building on 4.5.0. That means there's no way to not link subsequent instances of a refe... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | CAM-Gerlach |
| hostname | github.com |
| expected-hostname | github.com |
| None | 54182691a21263b584d2e600b758e081b0ff1d10ffc0d2eefa51cf754b43b51d |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | d69ac0477df0f87da03b8b06cebd187012d7a930 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width