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.

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

bpo-30052: Always regenerate cross-references #1339

Merged

Conversation

ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented Apr 28, 2017

The patch for bpo-30052 changed the preferred link target
for :func:bytes and :funcbytearray references to be the
respective type definitions rather than the corresponding
builtin function entries.

This patch changes the daily documentation builds to disable
the output caching in Sphinx, in order to ensure that
cross-reference changes like this one are reliably picked
up and applied automatically after merging.

@mention-bot
Copy link

@ncoghlan, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @benjaminp and @tiran to be potential reviewers.

The patch for bpo-30052 changed the preferred link target
for :func:`bytes` and :func`bytearray` references to be the
respective type definitions rather than the corresponding
builtin function entries.

This patch changes the daily documentation builds to disable
the output caching in Sphinx, in order to ensure that
cross-reference changes like this one are reliably picked
up and applied automatically after merging.
Copy link
Member

@berkerpeksag berkerpeksag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. This probably will fix python/docsbuild-scripts#10 too.

Misc/NEWS Outdated
@@ -984,6 +984,15 @@ C API
Documentation
-------------

- Issue #30052: the link targets for ``:func:\`bytes\``` and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This breaks travis build.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I can't work out how to get make suspicious to be OK with the escaped markup, so I've asked python-dev for advice: https://mail.python.org/pipermail/python-dev/2017-May/147820.html

@brettcannon brettcannon added the type-bug An unexpected behavior, bug, or error label May 1, 2017
@ncoghlan ncoghlan merged commit 7a82f9c into python:master Jun 2, 2017
ncoghlan added a commit to ncoghlan/cpython that referenced this pull request Jun 2, 2017
* bpo-30052: Always regenerate cross-references

The patch for bpo-30052 changed the preferred link target
for :func:`bytes` and :func`bytearray` references to be the
respective type definitions rather than the corresponding
builtin function entries.

This patch changes the daily documentation builds to disable
the output caching in Sphinx, in order to ensure that
cross-reference changes like this one are reliably picked
up and applied automatically after merging.
(cherry picked from commit 7a82f9c)
Mariatta pushed a commit that referenced this pull request Jun 6, 2017
The patch for bpo-30052 changed the preferred link target
for :func:`bytes` and :func`bytearray` references to be the
respective type definitions rather than the corresponding
builtin function entries.

This patch changes the daily documentation builds to disable
the output caching in Sphinx, in order to ensure that
cross-reference changes like this one are reliably picked
up and applied automatically after merging.
(cherry picked from commit 7a82f9c)
@ncoghlan ncoghlan deleted the bpo-30052-regenerate-cross-references branch March 30, 2018 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants