diff options
| author | Nick Coghlan <ncoghlan@gmail.com> | 2017-06-02 13:30:57 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-02 13:30:57 (GMT) |
| commit | 7a82f9c2b94d31c8f4cc8bb8e3151765d8b148d7 (patch) | |
| tree | 1eb705a4f506725c54a2111135a373b81a719fdf | |
| parent | aead53b6ee27915de248b07de509529174aaad21 (diff) | |
| download | cpython-7a82f9c2b94d31c8f4cc8bb8e3151765d8b148d7.zip cpython-7a82f9c2b94d31c8f4cc8bb8e3151765d8b148d7.tar.gz cpython-7a82f9c2b94d31c8f4cc8bb8e3151765d8b148d7.tar.bz2 | |
bpo-30052: Always regenerate cross-references (#1339)
* 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.
| -rw-r--r-- | Doc/Makefile | 9 | ||||
| -rw-r--r-- | Misc/NEWS | 9 |
2 files changed, 16 insertions, 2 deletions
diff --git a/Doc/Makefile b/Doc/Makefile index 94697f9..ae59f32 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -159,15 +159,20 @@ serve: ../Tools/scripts/serve.py build/html # Targets for daily automated doc build +# By default, Sphinx only rebuilds pages where the page content has changed. +# This means it doesn't always pick up changes to preferred link targets, etc +# To ensure such changes are picked up, we build the published docs with +# `-E` (to ignore the cached environment) and `-a` (to ignore already existing +# output files) # for development releases: always build autobuild-dev: - make dist SPHINXOPTS='$(SPHINXOPTS) -A daily=1 -A versionswitcher=1' + make dist SPHINXOPTS='$(SPHINXOPTS) -Ea -A daily=1 -A versionswitcher=1' -make suspicious # for quick rebuilds (HTML only) autobuild-dev-html: - make html SPHINXOPTS='$(SPHINXOPTS) -A daily=1 -A versionswitcher=1' + make html SPHINXOPTS='$(SPHINXOPTS) -Ea -A daily=1 -A versionswitcher=1' # for stable releases: only build if not in pre-release stage (alpha, beta) # release candidate downloads are okay, since the stable tree can be in that stage @@ -1109,6 +1109,15 @@ C API Documentation ------------- +- Issue #30052: the link targets for :func:`bytes` and + :func:`bytearray` are now their respective type definitions, rather + than the corresponding builtin function entries. Use :ref:`bytes <func-bytes>` + and :ref:`bytearray <func-bytearray>` to reference the latter. + + In order to ensure this and future cross-reference updates are applied + automatically, the daily documentation builds now disable the default + output caching features in Sphinx. + - bpo-26985: Add missing info of code object in inspect documentation. - bpo-19824, bpo-20314, bpo-12518: Improve the documentation for, and links |