Commit Graph

933 Commits

Author SHA1 Message Date
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
Georg Brandl 3b4cf554e5 rstlint: make the "html leaked markup" regex a bit less sensitive 2014-10-30 22:49:54 +01:00
Georg Brandl 9ac894aeff merge with 3.4 2014-10-30 22:45:01 +01:00
Georg Brandl 2273b096ce rstlint: we do not use svn anymore 2014-10-30 22:44:41 +01:00
Georg Brandl 759a02cacd merge with 3.4 2014-10-30 22:35:59 +01:00
Georg Brandl 95988f98ea rstlint: add more directives we use 2014-10-30 22:35:55 +01:00
Georg Brandl dd6b84d715 merge with 3.4 2014-10-30 22:31:08 +01:00
Georg Brandl f2b56518f9 rstlint: recognize "deprecated-removed" directive 2014-10-30 22:30:01 +01:00
Georg Brandl cadc3fdcb5 Merge with 3.4 2014-10-29 08:37:29 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl 46761ec7c2 Use https:// URLs in the HTML templates. 2014-10-29 08:36:15 +01:00
Georg Brandl 76c49a2fb9 merge with 3.4 2014-10-29 08:11:55 +01:00
Georg Brandl a1f8486325 Move HTML templates to their own subdir. 2014-10-29 08:11:46 +01:00
Georg Brandl d51c1a1953 merge with 3.4 2014-10-29 08:07:50 +01:00
Georg Brandl e03902910c Move Sphinx extensions to their own subdir. 2014-10-29 08:07:37 +01:00
Berker Peksag 8625dde150 Issue #22723: Make link styling more accessible.
Patch by Buck Golemon.
2014-10-25 05:21:17 +03:00
Berker Peksag 6d1c149a46 Issue #22723: Make link styling more accessible.
Patch by Buck Golemon.
2014-10-25 05:20:49 +03:00
Alex Gaynor e6f8c5025a Use https:// URLs for the bug tracker in the :issue: role.
Thanks to Ezio for noticing this
2014-10-13 12:58:03 -07:00
Alex Gaynor e285cdd997 Use https:// URLs for the bug tracker in the :issue: role.
Thanks to Ezio for noticing this
2014-10-13 12:58:03 -07:00
Larry Hastings 2ce95d7b7c Merge from 3.4.2 release head back into 3.4 mainline. 2014-10-08 02:50:50 -07:00
Larry Hastings c6256e5f7d Update pydoc topics and fix supsicious markup for 3.4.2 final. 2014-10-05 19:03:48 -07:00
Georg Brandl f7b2aa514e merge with 3.4 2014-10-01 19:42:09 +02:00
Georg Brandl 0428e6cc89 Remove old overridden version of a Sphinx CSS file.
All Python-specific styling is now in the theme anyway.
2014-10-01 19:41:31 +02:00
Georg Brandl 42c189efe4 merge with 3.4 2014-10-01 19:28:33 +02:00
Georg Brandl fd3a15a0cc Make pydoctheme compatible with Sphinx 1.3 HTML output changes. 2014-10-01 19:28:23 +02:00
Georg Brandl 61bd1dcf9b Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore. 2014-09-30 22:56:38 +02:00
Georg Brandl 97e9ec688c Move Doc/tools/sphinxext content to Doc/tools, there is no need for the nested subdirectory anymore. 2014-09-30 22:51:30 +02:00
Georg Brandl 7552eb89b9 merge with 3.4 2014-09-30 22:17:48 +02:00
Georg Brandl bae334cda9 Prepare sphinx extensions for 1.3. 2014-09-30 22:17:41 +02:00
Ned Deily b682fd3dbb Issue #21431: merge from 3.4 2014-09-22 14:44:22 -07:00
Georg Brandl 90d76ca765 Closes #21431: make docs depend on Sphinx 1.2 and fix pydoc-topics builder to
return Unicode strings on Python 3.
2014-09-22 21:18:24 +02:00
Benjamin Peterson 50ff85812f merge 3.4 2014-09-13 01:45:50 -04:00
Benjamin Peterson 7c8b89e156 make hg link secure 2014-09-13 01:44:34 -04:00
Berker Peksag adc5634193 Issue #22150: Fix deprecated-removed directive in Sphinx 1.2. 2014-08-22 18:25:16 +03:00
Berker Peksag eb265ab873 Issue #22150: Fix deprecated-removed directive in Sphinx 1.2. 2014-08-22 18:24:29 +03:00
Senthil Kumaran 6120ab8150 merge from 3.4
Update references to Python docs in the sidebar index.
Patch contributed by Auke Willem Oosterhoff.
2014-06-02 23:00:43 -07:00
Senthil Kumaran 8dc3df1b60 Update references to Python docs in the sidebar index.
Patch contributed by Auke Willem Oosterhoff.
2014-06-02 22:58:13 -07:00
Benjamin Peterson d065c48991 fix ref count annotations on sphinx >= 1.2.1 (closes #21286) 2014-04-17 18:29:01 -04:00
Benjamin Peterson af7c5b0bb5 merge 3.4 2014-04-17 18:29:27 -04:00
Georg Brandl aa1403c440 merge with 3.4 2014-03-28 19:49:02 +01:00
Georg Brandl 865bdbf4af Doc: do not compress .epub for dist, it is already zipped. 2014-03-28 19:48:55 +01:00
Georg Brandl b50f8c9c0d merge with 3.4 2014-03-25 10:13:44 +01:00
Georg Brandl 1afe2af690 Closes #21045: make the Qt help build not look completely stupid 2014-03-25 10:12:47 +01:00
Georg Brandl 3f2350c647 merge with 3.4 2014-03-18 07:47:35 +01:00
Georg Brandl 3a748ca982 merge with 3.4 2014-03-17 07:36:59 +01:00
Georg Brandl a7f48019d5 merge with 3.3 2014-03-17 07:36:51 +01:00
Georg Brandl 56d3a03f70 Update doc version switcher for 3.4/3.5. 2014-03-17 07:36:45 +01:00
Larry Hastings 3c5c56f3c0 Merged default into 3.4 branch. 3.4 branch is now effectively 3.4.1rc1. 2014-03-16 22:54:05 -07:00
Larry Hastings cf1a3cd2c7 Release bump for 3.4.0 final. 2014-03-15 22:34:24 -07:00
Larry Hastings 0548f5c514 Regenerate pydoc_topics, fix markup errors, in preparation for 3.4.0 final. 2014-03-15 22:29:19 -07:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Nick Coghlan f7614d55a2 Close #19407: New installation & distribution guides
- based on pip and other PyPA tools
- includes references to the new Python Packaging User Guide
  where appropriate (and the relevant section is at least
  partially filled in)
- started new FAQ sections
- both guides aim to introduce users to basic open source
  concepts if they aren't aware of them
- existing guides have been relocated (now linked from the
  distutils docs) rather then removed, since there is
  some needed material that has yet to be relocated to the
  distutils docs as a reference for the legacy formats
2014-03-13 22:13:45 +10:00
Georg Brandl 18a364fc3d Closes #20090: update Doc/README and the error message in sphinx-build.py to make
it clear that any Python 3.x is not usable with the checked out Sphinx.
2014-03-10 19:26:57 +01:00
Georg Brandl b6111f5529 Remove unused sphinx-build.py entry script. 2014-03-10 19:10:29 +01:00
Larry Hastings a3188ef476 Update pydoc topics and suspicious filters. 2014-03-09 04:12:12 -07:00
Georg Brandl 09141c4782 Closes #20755: port sphinx-1.1 fixes from default 2014-02-24 09:35:07 +01:00
Georg Brandl f7b2f36f74 Doc: do not rely on checked-out Sphinx toolchain from svn.python.org anymore
Nowadays it is likely that people will have Sphinx installed,
and if not, they will know how to install it.

This also simplifies life a lot for distribution packagers,
who typically do not want the doc build process to connect
to external web resources.
2014-02-16 09:46:36 +01:00
Georg Brandl d8413bab22 merge with 3.3 2014-02-10 22:11:21 +01:00
Georg Brandl b38b5c43c7 merge with 3.3 2014-02-10 22:11:21 +01:00
Larry Hastings 0e25410319 Documentation fixes, including fixing "suspicious" problems. 2014-01-26 00:42:02 -08:00
Georg Brandl bcf692417f doc: pydoc topic and suspicious markup update 2014-01-25 09:15:44 +01:00
Georg Brandl 2866c6a2a1 merge with 3.3 2014-01-21 19:20:58 +01:00
Georg Brandl 7ed509a38f fix deprecated-removed directive with sphinx 1.2 2014-01-21 19:20:31 +01:00
Georg Brandl ed007d5b1b Fix suspicious markup in the docs. 2013-11-24 16:09:26 +01:00
Georg Brandl 325a1c2f37 Fix markup errors in the docs and amend suspicious ignores. 2013-10-27 09:16:01 +01:00
Georg Brandl 186729e812 merge with 3.3 2013-10-27 09:54:53 +01:00
Ezio Melotti 33fc6d6040 #4965: merge with 3.3. 2013-10-14 02:59:54 +03:00
Ezio Melotti 47fd9d8e09 #4965: Implement intelligent scrolling of the sidebar in the docs. 2013-10-14 02:58:59 +03:00
Georg Brandl 03d010be14 merge with 3.3 2013-10-13 22:20:08 +02:00
Georg Brandl c3a2916919 Closes #19248: actually check for Python 3.x in tools/sphinx-build.py. 2013-10-13 22:19:49 +02:00
Georg Brandl bcdb4fd83c merge with 3.3 2013-10-13 09:56:24 +02:00
Georg Brandl 5d5b375c84 Fix a small CSS glitch with deprecated blocks and Sphinx 1.2. 2013-10-13 09:56:20 +02:00
Georg Brandl a7bb9b3a13 merge with 3.3 2013-10-13 09:32:00 +02:00
Georg Brandl 1e32011306 Fix display of deprecated blocks with Sphinx 1.2. 2013-10-13 09:31:42 +02:00
Georg Brandl 793d8478ee merge with 3.3 2013-10-12 22:56:37 +02:00
Georg Brandl a14034872b Invert logic of new limited-API annotation and call it "stable ABI". 2013-10-12 22:55:34 +02:00
Georg Brandl e9bd31f98f merge with 3.3 2013-10-12 20:53:53 +02:00
Georg Brandl 239990daec Fix compatibility with upcoming Sphinx 1.2. 2013-10-12 20:50:21 +02:00
Georg Brandl 7c11e52f7e merge with 3.3 2013-10-12 20:01:14 +02:00
Georg Brandl 5c01d99c12 Introduce support for documenting which C API elements are not part of the stable/limited API. 2013-10-12 19:54:30 +02:00
Ezio Melotti f2c64ed9eb Merge improvements to the suspicious builder and cleanup from 3.3. 2013-03-28 17:46:20 +02:00
Ezio Melotti a5d55baecc Update the suspicious builder to detect unused rules, and remove currently unusued rules. 2013-03-28 17:40:24 +02:00
Ezio Melotti f92b063c4e Update suspicious ignore file. 2013-03-28 05:12:31 +02:00
Ezio Melotti e5caf29743 Update suspicious ignore file. 2013-03-28 04:54:58 +02:00
Ezio Melotti fd4365a4d8 Update suspicious ignore file. 2013-03-28 04:31:53 +02:00
Ezio Melotti d2685260c4 #4711: merge with 3.3. 2012-11-03 18:29:31 +02:00
Ezio Melotti befaac03bb #4711: merge with 3.2. 2012-11-03 18:29:16 +02:00
Ezio Melotti dedfa9bfae #4711: break long words in the docs sidebar to avoid overflow. 2012-11-03 18:25:04 +02:00
Georg Brandl 9e80124ca2 merge with 3.3 2012-10-28 08:00:01 +01:00
Georg Brandl ab5da6a80e merge with 3.2 2012-10-28 07:59:54 +01:00
Georg Brandl fffc25da83 #8040: fix jQuery incompatibility 2012-10-28 07:59:42 +01:00
Ezio Melotti 0f3dae41ef #8040: merge with 3.3. 2012-10-27 23:13:34 +03:00