classification
Title: cross-referencing doesn't work between the extending guide and c-api
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.3, Python 3.4, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, ezio.melotti, georg.brandl, pitrou, python-dev
Priority: high Keywords:

Created on 2013-07-29 18:22 by pitrou, last changed 2013-08-01 19:17 by pitrou. This issue is now closed.

Messages (5)
msg193887 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2013-07-29 18:22
It doesn't seem possible to make reference links to e.g. the definition for tp_clear. Both :attr:`tp_clear` and :attr:`PyTypeObject.tp_clear` do not make any link. The extending guide is littered with such broken references.
msg193888 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2013-07-29 18:29
Ahah, it seems the correct markup is :c:member:`~PyTypeObject.tp_clear`

Now all the existing references have to be fixed...
msg193889 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2013-07-29 18:35
The following command does the trick:

sed -i "s/:attr:\`tp_/:c:member:\`~PyTypeObject.tp_/g" `find -name "*.rst"`

It does not fix word-wrapping, though. Is it ok to commit?
msg194106 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-08-01 19:14
New changeset a381721299a3 by Antoine Pitrou in branch '3.3':
Issue #18589: fix hyperlinking of type slots (tp_*)
http://hg.python.org/cpython/rev/a381721299a3

New changeset 36ff479e429c by Antoine Pitrou in branch 'default':
Issue #18589: fix hyperlinking of type slots (tp_*)
http://hg.python.org/cpython/rev/36ff479e429c
msg194107 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-08-01 19:17
New changeset bb546f6d8ab4 by Antoine Pitrou in branch '2.7':
Issue #18589: fix hyperlinking of type slots (tp_*)
http://hg.python.org/cpython/rev/bb546f6d8ab4
History
Date User Action Args
2013-08-01 19:17:52pitrousetstatus: open -> closed
resolution: fixed
stage: resolved
2013-08-01 19:17:32python-devsetmessages: + msg194107
2013-08-01 19:14:54python-devsetnosy: + python-dev
messages: + msg194106
2013-07-29 18:35:23pitrousetmessages: + msg193889
2013-07-29 18:29:42pitrousetmessages: + msg193888
2013-07-29 18:22:04pitroucreate