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

bpo-30052: Always regenerate cross-references #1339

Merged
merged 3 commits into from
Jun 2, 2017
Merged

bpo-30052: Always regenerate cross-references #1339

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3766314
bpo-30052: Always regenerate cross-references
ncoghlan Apr 28, 2017
f0b3c0b
Don't attempt to escape markup in NEWS
ncoghlan May 1, 2017
8054773
Merge remote-tracking branch 'origin/master' into bpo-30052-regenerat…
ncoghlan May 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions Doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions Misc/NEWS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

``:func:\`bytearray\``` are now their respective type definitions, rather
than the corresponding builtin function entries. Use ``:ref:\`func-bytes\```
and ``:ref:\`func-bytes\``` 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
Expand Down