Pablo Galindo
ee171a26c1
Stop using deprecated logging API in Sphinx suspicious checker (GH-9875)
2018-10-15 20:07:23 +01:00
Stéphane Wirtel
e385d0661e
bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)
2018-10-13 08:14:08 +02:00
Cheryl Sabella
2d6097d027
bpo-11233: Create availability directive for documentation (GH-9692)
...
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.
Co-Authored-By: Georg Brandl <georg@python.org>
2018-10-12 16:55:20 +02:00
animalize
6261ae9b01
bpo-32174: Let .chm document display non-ASCII characters properly (GH-9758)
...
Let .chm document display non-ASCII characters properly
Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual effect on some MBCS Windows systems.
2018-10-08 14:20:54 -07:00
Petr Viktorin
2d3ff2b5ea
bpo-24937: Replace the extension module porting HOWTO by links to external projects (GH-9317)
2018-09-24 12:42:33 +02:00
Yury Selivanov
471503954a
bpo-33649: Add a high-level section about Futures; few quick fixes (GH-9403)
...
Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
2018-09-18 17:55:44 -04:00
Yury Selivanov
394374e30c
bpo-33649: Add low-level APIs index. (GH-9364)
2018-09-17 15:35:24 -04:00
Ned Deily
aee5df5e16
Forward port 3.7.0 final changes
2018-06-27 18:45:50 -04:00
Zvezdan Petkovic
c2f082e9d1
bpo-13631: Fix the order of initialization for readline libedit on macOS. (GH-6915)
...
The editline emulation needs to be initialized *after* the name is
defined. This fixes the long open issue.
2018-05-17 02:45:10 -04:00
Dong-hee Na
5779483299
bpo-33378: Add Korean to the language switcher. (GH-6627)
2018-04-28 22:08:22 +02:00
Benjamin Peterson
acfb087f9f
fix pydoc-topics to work with Sphinx 1.7 (GH-6475)
...
In fact, we now require a newer Sphinx version because APIs have moved around.
2018-04-16 22:56:46 -07:00
Jon Wayne Parrott
bf63e8d55f
bpo-30607: Use external python-doc-theme (GH-2017)
2018-03-01 16:02:50 -05:00
cocoatomo
0febc05373
bpo-32087: Doc: Make "deprecated-removed" directive translatable (GH-4473)
2018-02-23 20:47:19 +09:00
Ned Deily
07a1892f82
Update Doc build to 3.8
2018-01-31 18:12:38 -05:00
Nick Coghlan
9b99747386
bpo-31975 (PEP 565): Show DeprecationWarning in __main__ (GH-4458)
...
- primary change is to add a new default filter entry for
'default::DeprecationWarning:__main__'
- secondary change is an internal one to cope with plain
strings in the warning module's internal filter list
(this avoids the need to create a compiled regex object
early on during interpreter startup)
- assorted documentation updates, including many more
examples of configuring the warnings settings
- additional tests to ensure that both the pure Python and
the C accelerated warnings modules have the expected
default configuration
2018-01-08 12:45:02 +10:00
Victor Stinner
747f48e2e9
bpo-32230: Set sys.warnoptions with -X dev ( #4820 )
...
Rather than supporting dev mode directly in the warnings module, this
instead adjusts the initialisation code to add an extra 'default'
entry to sys.warnoptions when dev mode is enabled.
This ensures that dev mode behaves *exactly* as if `-Wdefault` had
been passed on the command line, including in the way it interacts
with `sys.warnoptions`, and with other command line flags like `-bb`.
Fix also bpo-20361: have -b & -bb options take precedence over any
other warnings options.
Patch written by Nick Coghlan, with minor modifications of Victor Stinner.
2017-12-12 22:59:48 +01:00
Serhiy Storchaka
05cb728d68
bpo-30349: Raise FutureWarning for nested sets and set operations ( #1553 )
...
in regular expressions.
2017-11-16 12:38:26 +02:00
Victor Stinner
8c663fd60e
Replace KB unit with KiB ( #4293 )
...
kB (*kilo* byte) unit means 1000 bytes, whereas KiB ("kibibyte")
means 1024 bytes. KB was misused: replace kB or KB with KiB when
appropriate.
Same change for MB and GB which become MiB and GiB.
Change the output of Tools/iobench/iobench.py.
Round also the size of the documentation from 5.5 MB to 5 MiB.
2017-11-08 14:44:44 -08:00
Ned Deily
b7cbfe49e3
bpo-31766: restore 3.5 to docs version switchers ( #3969 )
2017-10-12 14:08:43 -04:00
Jelle Zijlstra
ac317700ce
bpo-30406: Make async and await proper keywords ( #1669 )
...
Per PEP 492, 'async' and 'await' should become proper keywords in 3.7.
2017-10-05 23:24:46 -04:00
Ned Deily
e2d0dd2cf9
Remove retired and security branches from active docs ( #3879 )
2017-10-03 22:56:19 -04:00
Dmitry Chestnykh
aecc08ac3a
Docs: correct hashlib.blake2 keyed hashing example (bpo-31560)
2017-09-23 10:18:40 -07:00
Ned Deily
52451fbaaf
Prevent a few make suspicious warnings. ( #3341 )
2017-09-05 01:34:47 -07:00
larryhastings
f9f17346d7
Blurbify master branch. ( #3298 )
...
Blurbify master branch.
2017-09-04 13:30:19 -07:00
Elmar Ritsch
b9ff498793
Fix broken `Show Source` links on documentation pages (GH-3113)
...
The `Show Source` was broken because of a change made in sphinx 1.5.1
In Sphinx 1.4.9, the sourcename was "index.txt".
In Sphinx 1.5.1+, it is now "index.rst.txt"
2017-08-17 20:23:51 -07:00
Julien Palard
b616b97299
Update the language selection in the docs language switch. (GH-3114)
...
Change the option for `Français` into `French` to be consistent with the other language selections that are already in English.
2017-08-17 07:24:02 -07:00
Julien Palard
122081deef
bpo-31159: fix language switch regex on unknown yet built languages. ( #3039 )
...
This fix a regex issue (a missing non-matching group around an 'or'
list) and the specific possible case where a translation is built but
not yet in known by the picker, but not explicitly listing possible
languages in the regex.
2017-08-09 17:01:15 +02:00
Julien Palard
c82b7f332a
bpo-31149: Doc: Add Japanese to the language switcher. ( #3028 )
2017-08-08 23:26:46 +02:00
Julien
dff9b5f9d6
bpo-31045: Language switch ( #2652 )
...
* Doc: Indicate the language
* Renaming version_switcher to switchers (to add language_switcher).
* Adding language switch.
* Doc switchers: Enhance readability of regex parsing versions.
* Doc switchers: Desambiguate the need of a replace(/\/+$/g, '') by proper naming.
* Doc switchers: py3k can't reach js, it's redirected server-side by nginx.
* Doc switchers: Examples matching actual regexes.
* Doc switchers: Better fallback on unexisting translated version.
2017-08-07 10:27:21 +02:00
Ned Deily
5bffcf38aa
Update doc download files size estimates. ( #2771 )
2017-07-20 03:58:46 -04:00
Ned Deily
50f58163a6
bpo-30939: Avoid Sphinx deprecation warning in docs build. ( #2721 )
2017-07-15 15:28:02 -04:00
Victor Stinner
272d888c7b
bpo-29783: Replace codecs.open() with io.open() ( #599 )
2017-06-16 08:59:01 +02:00
Serhiy Storchaka
d97b7dc94b
bpo-30380: Fix Sphinx 1.6.1 warnings. ( #1613 )
...
* Use explicit numbering for footnotes referred by explicit number.
* Restore missed footnote reference in stdtypes.rst.
* Fix literal strings formatting in howto/urllib2.rst.
* Update susp-ignored.csv for zipapp.rst.
* Fix suspicious mark up in Misc/NEWS.
2017-05-16 23:18:09 +03:00
Xiang Zhang
13f1f423fa
bpo-30103: Allow Uuencode in Python using backtick as zero instead of space ( #1326 )
2017-05-03 11:16:21 +08:00
Serhiy Storchaka
5908300e4b
bpo-29995: re.escape() now escapes only special characters. ( #1007 )
2017-04-13 21:06:43 +03:00
Serhiy Storchaka
8fc7bc2b76
bpo-30021: Add examples for re.escape(). ( #1048 )
...
And fix the parameter name.
2017-04-13 19:17:36 +03:00
cocoatomo
f8beb9831a
bpo-29888: Fix the link referring to the "Python download page" (GH-824)
2017-03-26 13:32:24 -04:00
INADA Naoki
c351ce6a2c
bpo-28331: fix impl-detail label is removed when content is translated. (GH-195)
2017-03-08 19:07:13 +09:00
INADA Naoki
e395c4dbe1
bpo-29520: doc: add missing dot (GH-182)
...
3eea8c6
missed dot at the end of paragraph.
2017-02-20 10:22:28 +09:00
INADA Naoki
3eea8c67fa
bpo-29520: doc: fix deprecation warning from 'defindex' template (GH-165)
2017-02-20 02:07:32 +09:00
Mariatta
d4a97d8948
bpo-28929: Link the documentation to its source file on GitHub ( #35 )
...
* bpo-28929: Link the documentation to its source file on GitHub
Change the documentation's `Show Source` link on the left menu
to GitHub source file.
* change version to master
2017-02-12 13:07:05 -08:00
Brett Cannon
79ab8be05f
Support "bpo-" in Misc/NEWS ( #1 )
2017-02-10 17:10:13 -06:00
Nick Coghlan
c7a24a7330
Merge issue #26355 fix from 3.6
2017-02-09 16:09:03 +01:00
Nick Coghlan
e1857579f8
Merge issue #26355 fix from Python 3.5
2017-02-09 16:08:17 +01:00
Nick Coghlan
e66244521c
Issue #26355 : Specify canonical URLs in docs pages
...
Add canonical header link on each page to corresponding major
version of the documentation.
Patch by Matthias Bussonnier.
2017-02-09 16:03:59 +01:00
Martin Panter
f24bcccefd
Issue #28822 : Add susp-ignored entry for NEWS; fix grammar
2017-01-29 23:37:56 +00:00
Martin Panter
ba964cc5f7
Issues #29349 : Merge Py 2.6+ compatibility from 3.6
2017-01-29 23:37:24 +00:00
Martin Panter
b154113251
Issues #29349 : Merge Py 2.6+ compatibility from 3.5
2017-01-29 23:34:52 +00:00
Martin Panter
9a454021a4
Issue #29349 : Use __future__ print_function; Sphinx may use Python 2.6+
2017-01-29 23:33:13 +00:00
Martin Panter
c654f0acf9
Issues #29349 : Add NEWS for 3.7; use “with” statement
2017-01-29 10:17:17 +00:00
Martin Panter
3a6dc19f6e
Issues #29349 : Merge Py 2 fix 3.6
2017-01-29 10:16:28 +00:00
Martin Panter
e61592e7e1
Issues #29349 : Merge Py 2 fix 3.5
2017-01-29 10:09:43 +00:00
Martin Panter
8f3fb72309
Issue #29349 : Fix Python 2 syntax in documentation build code
2017-01-29 10:05:02 +00:00
INADA Naoki
f25dec904c
Issue #29062 : Doc: Fix make suspicious
2017-01-14 21:04:40 +09:00
INADA Naoki
2e1b6ea4b7
Issue #29062 : Doc: Fix make suspicious
2017-01-14 21:04:21 +09:00
Ned Deily
9800686714
Update documentation index sidebar for 3.6.0 release.
2016-12-23 04:17:38 -05:00
Ned Deily
e31b15c4ce
Update documentation index sidebar for 3.6.0 release.
2016-12-23 04:13:31 -05:00
Ned Deily
864a78ed72
Issue #28900 : Update documentation sidebar for 3.6.0rc.
2016-12-07 23:38:30 -05:00
Ned Deily
098f85bb7d
Issue #28900 : Update documentation sidebar for 3.6.0rc.
2016-12-07 23:37:12 -05:00
Ned Deily
932d40abf7
Issue #28900 : Update documentation sidebar for 3.6.0rc.
2016-12-07 23:34:49 -05:00
Zachary Ware
3d1caab7b9
Merge with 3.6
2016-11-17 23:31:29 -06:00
Zachary Ware
d23881e3a0
Ignore newly added suspicious line
2016-11-17 23:30:27 -06:00
Zachary Ware
6743999d74
Remove unused suspicious rules
2016-10-25 21:49:19 -05:00
Zachary Ware
ec9357b90c
Ignore harmless suspicious markup
2016-10-25 21:43:41 -05:00
Steve Dower
765285337a
Issue #28251 : Improvements to help manuals on Windows.
2016-09-22 17:09:56 -07:00
Steve Dower
fb4a96a58f
Issue #28251 : Improvements to help manuals on Windows.
2016-09-22 17:07:56 -07:00
Ned Deily
7582bcaa8f
Make 3.7 the current dev version in the html version of the docs.
2016-09-20 15:00:53 -04:00
Ned Deily
a327331cec
Make 3.7 the current dev version in the html version of the docs.
2016-09-20 15:00:07 -04:00
Ned Deily
0112625fba
Change SOURCE_URI for pydoc source URLs to point to 3.6 branch
2016-09-12 10:56:13 -04:00
Ned Deily
ef71d20548
Add some additional suspicious exemption rules for recent doc changes.
2016-09-11 15:49:37 -04:00
Zachary Ware
b44acebc7b
Actually fix suspicious markup, I ignored it too readily
2016-09-09 17:47:38 -07:00
Zachary Ware
39b42ae8db
Remove line numbers from suspicious rules
2016-09-09 17:38:28 -07:00
Zachary Ware
12aeb78fd2
Fix suspicious markup
2016-09-09 15:46:14 -07:00
Zachary Ware
9539963a44
Remove unused suspicious rules
2016-09-09 13:26:47 -07:00
Zachary Ware
9c85828463
Closes #19489 : Merge with 3.5
2016-09-09 13:11:58 -07:00
Zachary Ware
a3090a4b79
Issue #19489 : Move the search box from sidebar to header and footer.
2016-09-09 13:11:27 -07:00
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)
a68c1bca7b
Remove legacy "from __future__ import with_statement" lines.
2016-09-08 13:47:41 -07:00
Benjamin Peterson
dfc853c527
shut up some perfectly innocent reST in hashlib-blake2
2016-09-06 14:37:37 -07:00
Martin Panter
d2fe862bab
Issue #27285 : Cleanup leftover susp-ignored entry after text was changed
2016-07-16 07:17:46 +00:00
Ned Deily
538f5c4786
Issue #27285 : Cleanup "suspicious" warnings.
2016-07-11 14:21:58 -04:00
Martin Panter
590dcab95a
Merge spelling fixes from 3.5
2016-06-20 07:55:14 +00:00
Martin Panter
2275e626b1
Fix spelling errors in code comments
2016-06-20 07:52:50 +00:00
Berker Peksag
d1f534065c
Merge from 3.5
2016-06-11 22:38:57 +03:00
Berker Peksag
326196047f
Silence 'make suspicious' warnings
2016-06-11 22:38:33 +03:00
Martin Panter
b198c42bcb
Fix RST conflicts with Idle news entries
2016-06-08 13:32:49 +00:00
Martin Panter
37917369d5
Issue #23806 : Merge susp-ignored.csv from 3.5
2016-04-24 04:07:58 +00:00
Martin Panter
887bc96e2e
Issue #23806 : Update susp-ignored.csv
2016-04-24 04:06:15 +00:00
Ezio Melotti
4c9375b65f
#24918 : merge with 3.5.
2016-03-13 11:41:45 +02:00
Ezio Melotti
f2b9a39813
#24918 : fix CSS for code blocks when a side box is present. Patch by Manvi B.
2016-03-13 11:41:05 +02:00
Berker Peksag
998f7d719b
Issue #26246 : Set initial value of the hidden attr when creating copy button.
...
Patch by Liang-Bo Wang.
2016-03-02 19:40:50 +02:00
Berker Peksag
ff47cfbc66
Issue #26246 : Set initial value of the hidden attr when creating copy button.
...
Patch by Liang-Bo Wang.
2016-03-02 19:40:30 +02:00
Berker Peksag
25c0ef518d
Issue #26246 : Set initial value of the hidden attr when creating copy button.
...
Patch by Liang-Bo Wang.
2016-03-02 19:40:08 +02:00
Georg Brandl
d047c2f8b2
merge with 3.5
2016-02-28 21:13:44 +01:00
Georg Brandl
96421d6f11
Update susp-ignore file ( #25910 ).
2016-02-28 21:13:23 +01:00
Ezio Melotti
b8d75035f2
#26246 : merge with 3.5.
2016-02-27 08:42:14 +02:00
Ezio Melotti
738f88f688
#26246 : merge with 3.4.
2016-02-27 08:41:16 +02:00
Ezio Melotti
90ba2ca68a
#26246 : update copybutton.js after JQuery update. Patch by Liang-Bo Wang.
2016-02-27 08:39:36 +02:00
Georg Brandl
057ab49a6b
merge with 3.5
2016-02-25 20:14:21 +01:00
Georg Brandl
2305b3cde3
Fix rstlint to also look for indented comments that should be directives.
2016-02-25 20:14:10 +01:00
Martin Panter
46988d3659
Merge string formatting doc fixes from 3.5
2016-02-08 01:49:35 +00:00
Martin Panter
d5db14794b
Issue #25179 : Preparatory cleanup of existing docs on string formatting
...
* Various sections were pointing to the section on the string.Formatter
class, when the section on the common format string syntax is probably more
appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
and this is tested; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Victor Stinner
bf980797af
Merge 3.5 (i18n doc, issue #25907 )
2016-01-22 18:00:31 +01:00
Victor Stinner
875f29aa69
doc: i18n HTML templates
...
Issue #25907 : Use {% trans %} tags in HTML templates to ease the translation of
the documentation. The tag comes from Jinja templating system, used by Sphinx.
Patch written by Julien Palard.
2016-01-22 18:00:05 +01:00
Benjamin Peterson
e45abae08f
merge 3.5 ( #26172 )
2016-01-20 22:03:00 -08:00
Benjamin Peterson
b57eaeadff
merge 3.4 ( #26172 )
2016-01-20 22:02:47 -08:00
Benjamin Peterson
c836f717cd
remove script from epub ( closes #26172 )
2016-01-20 22:02:30 -08:00
Berker Peksag
2e7fca8e48
Issue #21240 : Add an abstractmethod directive to mark abstract methods in the docs more explicitly
2015-12-08 12:15:19 +02:00
Berker Peksag
6e9d2e687b
Issue #21240 : Add an abstractmethod directive to mark abstract methods in the docs more explicitly
2015-12-08 12:14:50 +02:00
Berker Peksag
a1331c4700
Silence a "unused rule" warning
...
This one should make Docs 3.5 and Docs 3.x green again.
2015-10-20 03:59:41 +03:00
Berker Peksag
1d1697930b
Silence a "unused rule" warning
...
This one should make Docs 3.5 and Docs 3.x green again.
2015-10-20 03:59:24 +03:00
Berker Peksag
4b5d8018df
Merge from 3.5
...
Hg: --
2015-10-02 23:29:13 +03:00
Berker Peksag
8214a7c38f
Tweak susp-ignored.csv to make buildbots happy
2015-10-02 23:28:45 +03:00
Berker Peksag
9289e9038f
Issue #25105 : Update susp-ignored.csv to avoid false positives
2015-09-15 19:43:26 +03:00
Berker Peksag
055395eed2
Issue #25105 : Update susp-ignored.csv to avoid false positives
2015-09-15 19:43:04 +03:00
Martin Panter
b7ccb5d6c3
Issue #25022 : Merge susp-ignored.csv from 3.5
2015-09-11 02:47:13 +00:00
Martin Panter
02918caeb8
Issue #25022 : Merge susp-ignored.csv from 3.4 into 3.5
2015-09-11 02:46:54 +00:00
Martin Panter
91c03e090a
Issue #25022 : Avoid warning about unused suspicious rule
2015-09-11 02:45:10 +00:00
Martin Panter
015e3f65bc
Issue #23406 : Merge 3.5 into 3.6
2015-09-07 04:05:57 +00:00
Martin Panter
6cb196306a
Issue #23406 : Remove specific line number from susp-ignored.csv
2015-09-07 03:40:17 +00:00
Robert Collins
6afa84cfed
Remove line numbers from unittest in susp-ignored.
2015-07-23 08:09:05 +12:00
Robert Collins
943ddac142
Remove line numbers from unittest in susp-ignored.
2015-07-23 08:08:59 +12:00
Robert Collins
80e4f30e64
Remove line numbers from unittest in susp-ignored.
2015-07-23 08:08:38 +12:00
Robert Collins
cb4a6c1889
Merge unittest docs suspicious fix.
2015-07-23 07:32:39 +12:00
Robert Collins
6cd5635333
Merge unittest docs suspicious fix.
2015-07-23 07:32:27 +12:00
Robert Collins
16dd210543
Fix suspicious after the unittest docs change.
2015-07-23 07:07:07 +12:00
Zachary Ware
cafc34fa3d
Merge with 3.5
2015-07-21 22:50:54 -05:00
Zachary Ware
d7841ef48b
Merge with 3.4
2015-07-21 22:50:43 -05:00
Zachary Ware
4aa30dc275
rstlint: explicitly open files as UTF8
2015-07-21 22:50:29 -05:00
Zachary Ware
9f20bdb321
Merge 3.5
2015-07-07 00:34:37 -05:00
Zachary Ware
80d0651117
Update ignored suspicious markup
2015-07-07 00:34:25 -05:00
Zachary Ware
5c676f67d1
Fix suspicious markup
2015-07-06 23:27:15 -05:00
Ned Deily
da2d51f97a
merge 3.5.0b3 changes from 3.5
2015-07-05 11:17:43 -07:00
Larry Hastings
aaa377f01d
Documentation fixes for 3.5.0b3.
2015-07-04 19:11:41 -07:00
Larry Hastings
115b0da540
Change SOURCE_URI for pydoc source URLs to point back to correct branch for 3.6.
2015-05-30 17:28:56 -07:00
Benjamin Peterson
d663cc4848
merge 3.4
2015-05-27 18:32:41 -05:00
Benjamin Peterson
68fe9aa58c
update for 3.6 emerging
2015-05-27 18:32:25 -05:00
Larry Hastings
40040dfc4b
Update SOURCE_URI to reflect that we're branching 3.5 now.
2015-05-23 17:41:13 -07:00
Larry Hastings
0482af4269
Updated topics (and susp-ignored) for Python 3.5.0b1.
2015-05-23 17:39:42 -07:00
Larry Hastings
770ce204ee
Regenerated pydoc-topics and fixed bad/suspicious doc markup for Python 3.5.0a4.
2015-04-19 13:50:12 -07:00
Larry Hastings
b2c2dc3643
Regenerated pydoc topics and minor doc fixes for 3.5.0a3.
2015-03-29 15:32:55 -07:00
Victor Stinner
cbbdfb5933
Merge 3.4 (asyncio doc)
2015-02-17 23:11:56 +01:00
Victor Stinner
e170ed27c6
asyncio doc: fix the sphinx extension for coroutine commands
2015-02-17 23:08:35 +01:00
Victor Stinner
866ca88f2d
Merge 3.4 (asyncio doc)
2015-02-12 22:49:45 +01:00
Victor Stinner
bdd574d09a
asyncio doc: annotate coroutine on coroutine functions and methods
2015-02-12 22:49:18 +01:00
Berker Peksag
bf764a1912
Issue #22695 : Fix rendering of the deprecated-removed role in HTML.
2014-11-08 22:41:00 +02:00
Berker Peksag
eb1a3cd4ea
Issue #22695 : Fix rendering of the deprecated-removed role in HTML.
2014-11-08 22:40:22 +02:00
Georg Brandl
db3f318681
Doc: updadate suspicious ignore rules
2014-10-31 08:03:20 +01:00
Georg Brandl
e075f1617f
merge with 3.4
2014-10-30 22:56:04 +01:00
Georg Brandl
35903c809f
Sphinx extension: move imports to the module top
2014-10-30 22:55:13 +01:00
Georg Brandl
55c2ae8cb1
merge with 3.4
2014-10-30 22:50:00 +01:00