538f5c4786
Issue #27285 : Cleanup "suspicious" warnings.
2016-07-11 14:21:58 -04:00
590dcab95a
Merge spelling fixes from 3.5
2016-06-20 07:55:14 +00:00
2275e626b1
Fix spelling errors in code comments
2016-06-20 07:52:50 +00:00
d1f534065c
Merge from 3.5
2016-06-11 22:38:57 +03:00
326196047f
Silence 'make suspicious' warnings
2016-06-11 22:38:33 +03:00
b198c42bcb
Fix RST conflicts with Idle news entries
2016-06-08 13:32:49 +00:00
37917369d5
Issue #23806 : Merge susp-ignored.csv from 3.5
2016-04-24 04:07:58 +00:00
887bc96e2e
Issue #23806 : Update susp-ignored.csv
2016-04-24 04:06:15 +00:00
4c9375b65f
#24918 : merge with 3.5.
2016-03-13 11:41:45 +02:00
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
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
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
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
d047c2f8b2
merge with 3.5
2016-02-28 21:13:44 +01:00
96421d6f11
Update susp-ignore file ( #25910 ).
2016-02-28 21:13:23 +01:00
b8d75035f2
#26246 : merge with 3.5.
2016-02-27 08:42:14 +02:00
738f88f688
#26246 : merge with 3.4.
2016-02-27 08:41:16 +02:00
90ba2ca68a
#26246 : update copybutton.js after JQuery update. Patch by Liang-Bo Wang.
2016-02-27 08:39:36 +02:00
057ab49a6b
merge with 3.5
2016-02-25 20:14:21 +01:00
2305b3cde3
Fix rstlint to also look for indented comments that should be directives.
2016-02-25 20:14:10 +01:00
46988d3659
Merge string formatting doc fixes from 3.5
2016-02-08 01:49:35 +00:00
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
bf980797af
Merge 3.5 (i18n doc, issue #25907 )
2016-01-22 18:00:31 +01:00
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
e45abae08f
merge 3.5 ( #26172 )
2016-01-20 22:03:00 -08:00
b57eaeadff
merge 3.4 ( #26172 )
2016-01-20 22:02:47 -08:00
c836f717cd
remove script from epub ( closes #26172 )
2016-01-20 22:02:30 -08:00
2e7fca8e48
Issue #21240 : Add an abstractmethod directive to mark abstract methods in the docs more explicitly
2015-12-08 12:15:19 +02:00
6e9d2e687b
Issue #21240 : Add an abstractmethod directive to mark abstract methods in the docs more explicitly
2015-12-08 12:14:50 +02:00
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
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
4b5d8018df
Merge from 3.5
...
Hg: --
2015-10-02 23:29:13 +03:00
8214a7c38f
Tweak susp-ignored.csv to make buildbots happy
2015-10-02 23:28:45 +03:00
9289e9038f
Issue #25105 : Update susp-ignored.csv to avoid false positives
2015-09-15 19:43:26 +03:00
055395eed2
Issue #25105 : Update susp-ignored.csv to avoid false positives
2015-09-15 19:43:04 +03:00
b7ccb5d6c3
Issue #25022 : Merge susp-ignored.csv from 3.5
2015-09-11 02:47:13 +00:00
02918caeb8
Issue #25022 : Merge susp-ignored.csv from 3.4 into 3.5
2015-09-11 02:46:54 +00:00
91c03e090a
Issue #25022 : Avoid warning about unused suspicious rule
2015-09-11 02:45:10 +00:00
015e3f65bc
Issue #23406 : Merge 3.5 into 3.6
2015-09-07 04:05:57 +00:00
6cb196306a
Issue #23406 : Remove specific line number from susp-ignored.csv
2015-09-07 03:40:17 +00:00
6afa84cfed
Remove line numbers from unittest in susp-ignored.
2015-07-23 08:09:05 +12:00
943ddac142
Remove line numbers from unittest in susp-ignored.
2015-07-23 08:08:59 +12:00
80e4f30e64
Remove line numbers from unittest in susp-ignored.
2015-07-23 08:08:38 +12:00
cb4a6c1889
Merge unittest docs suspicious fix.
2015-07-23 07:32:39 +12:00
6cd5635333
Merge unittest docs suspicious fix.
2015-07-23 07:32:27 +12:00
16dd210543
Fix suspicious after the unittest docs change.
2015-07-23 07:07:07 +12:00
cafc34fa3d
Merge with 3.5
2015-07-21 22:50:54 -05:00
d7841ef48b
Merge with 3.4
2015-07-21 22:50:43 -05:00
4aa30dc275
rstlint: explicitly open files as UTF8
2015-07-21 22:50:29 -05:00
9f20bdb321
Merge 3.5
2015-07-07 00:34:37 -05:00
80d0651117
Update ignored suspicious markup
2015-07-07 00:34:25 -05:00
5c676f67d1
Fix suspicious markup
2015-07-06 23:27:15 -05:00
da2d51f97a
merge 3.5.0b3 changes from 3.5
2015-07-05 11:17:43 -07:00
aaa377f01d
Documentation fixes for 3.5.0b3.
2015-07-04 19:11:41 -07:00
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
d663cc4848
merge 3.4
2015-05-27 18:32:41 -05:00
68fe9aa58c
update for 3.6 emerging
2015-05-27 18:32:25 -05:00
40040dfc4b
Update SOURCE_URI to reflect that we're branching 3.5 now.
2015-05-23 17:41:13 -07:00
0482af4269
Updated topics (and susp-ignored) for Python 3.5.0b1.
2015-05-23 17:39:42 -07:00
770ce204ee
Regenerated pydoc-topics and fixed bad/suspicious doc markup for Python 3.5.0a4.
2015-04-19 13:50:12 -07:00
b2c2dc3643
Regenerated pydoc topics and minor doc fixes for 3.5.0a3.
2015-03-29 15:32:55 -07:00
cbbdfb5933
Merge 3.4 (asyncio doc)
2015-02-17 23:11:56 +01:00
e170ed27c6
asyncio doc: fix the sphinx extension for coroutine commands
2015-02-17 23:08:35 +01:00
866ca88f2d
Merge 3.4 (asyncio doc)
2015-02-12 22:49:45 +01:00
bdd574d09a
asyncio doc: annotate coroutine on coroutine functions and methods
2015-02-12 22:49:18 +01:00
bf764a1912
Issue #22695 : Fix rendering of the deprecated-removed role in HTML.
2014-11-08 22:41:00 +02:00
eb1a3cd4ea
Issue #22695 : Fix rendering of the deprecated-removed role in HTML.
2014-11-08 22:40:22 +02:00
db3f318681
Doc: updadate suspicious ignore rules
2014-10-31 08:03:20 +01:00
e075f1617f
merge with 3.4
2014-10-30 22:56:04 +01:00
35903c809f
Sphinx extension: move imports to the module top
2014-10-30 22:55:13 +01:00
55c2ae8cb1
merge with 3.4
2014-10-30 22:50:00 +01:00
3b4cf554e5
rstlint: make the "html leaked markup" regex a bit less sensitive
2014-10-30 22:49:54 +01:00
9ac894aeff
merge with 3.4
2014-10-30 22:45:01 +01:00
2273b096ce
rstlint: we do not use svn anymore
2014-10-30 22:44:41 +01:00
759a02cacd
merge with 3.4
2014-10-30 22:35:59 +01:00
95988f98ea
rstlint: add more directives we use
2014-10-30 22:35:55 +01:00
dd6b84d715
merge with 3.4
2014-10-30 22:31:08 +01:00
f2b56518f9
rstlint: recognize "deprecated-removed" directive
2014-10-30 22:30:01 +01:00
cadc3fdcb5
Merge with 3.4
2014-10-29 08:37:29 +01:00
e73778c1ac
Use https:// URLs when referring to python.org hosts.
2014-10-29 08:36:35 +01:00
46761ec7c2
Use https:// URLs in the HTML templates.
2014-10-29 08:36:15 +01:00
76c49a2fb9
merge with 3.4
2014-10-29 08:11:55 +01:00
a1f8486325
Move HTML templates to their own subdir.
2014-10-29 08:11:46 +01:00
d51c1a1953
merge with 3.4
2014-10-29 08:07:50 +01:00
e03902910c
Move Sphinx extensions to their own subdir.
2014-10-29 08:07:37 +01:00
8625dde150
Issue #22723 : Make link styling more accessible.
...
Patch by Buck Golemon.
2014-10-25 05:21:17 +03:00
6d1c149a46
Issue #22723 : Make link styling more accessible.
...
Patch by Buck Golemon.
2014-10-25 05:20:49 +03:00
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
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
2ce95d7b7c
Merge from 3.4.2 release head back into 3.4 mainline.
2014-10-08 02:50:50 -07:00
c6256e5f7d
Update pydoc topics and fix supsicious markup for 3.4.2 final.
2014-10-05 19:03:48 -07:00
f7b2aa514e
merge with 3.4
2014-10-01 19:42:09 +02:00
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
42c189efe4
merge with 3.4
2014-10-01 19:28:33 +02:00
fd3a15a0cc
Make pydoctheme compatible with Sphinx 1.3 HTML output changes.
2014-10-01 19:28:23 +02:00
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
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
7552eb89b9
merge with 3.4
2014-09-30 22:17:48 +02:00
bae334cda9
Prepare sphinx extensions for 1.3.
2014-09-30 22:17:41 +02:00
b682fd3dbb
Issue #21431 : merge from 3.4
2014-09-22 14:44:22 -07:00
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
50ff85812f
merge 3.4
2014-09-13 01:45:50 -04:00
7c8b89e156
make hg link secure
2014-09-13 01:44:34 -04:00
adc5634193
Issue #22150 : Fix deprecated-removed directive in Sphinx 1.2.
2014-08-22 18:25:16 +03:00
eb265ab873
Issue #22150 : Fix deprecated-removed directive in Sphinx 1.2.
2014-08-22 18:24:29 +03:00
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
8dc3df1b60
Update references to Python docs in the sidebar index.
...
Patch contributed by Auke Willem Oosterhoff.
2014-06-02 22:58:13 -07:00
d065c48991
fix ref count annotations on sphinx >= 1.2.1 ( closes #21286 )
2014-04-17 18:29:01 -04:00
af7c5b0bb5
merge 3.4
2014-04-17 18:29:27 -04:00
aa1403c440
merge with 3.4
2014-03-28 19:49:02 +01:00
865bdbf4af
Doc: do not compress .epub for dist, it is already zipped.
2014-03-28 19:48:55 +01:00
b50f8c9c0d
merge with 3.4
2014-03-25 10:13:44 +01:00
1afe2af690
Closes #21045 : make the Qt help build not look completely stupid
2014-03-25 10:12:47 +01:00
3f2350c647
merge with 3.4
2014-03-18 07:47:35 +01:00
3a748ca982
merge with 3.4
2014-03-17 07:36:59 +01:00
a7f48019d5
merge with 3.3
2014-03-17 07:36:51 +01:00
56d3a03f70
Update doc version switcher for 3.4/3.5.
2014-03-17 07:36:45 +01:00
3c5c56f3c0
Merged default into 3.4 branch. 3.4 branch is now effectively 3.4.1rc1.
2014-03-16 22:54:05 -07:00
cf1a3cd2c7
Release bump for 3.4.0 final.
2014-03-15 22:34:24 -07:00
0548f5c514
Regenerate pydoc_topics, fix markup errors, in preparation for 3.4.0 final.
2014-03-15 22:29:19 -07:00
3732ed2414
Merge in all documentation changes since branching 3.4.0rc1.
2014-03-15 21:13:56 -07:00
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
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
b6111f5529
Remove unused sphinx-build.py entry script.
2014-03-10 19:10:29 +01:00
a3188ef476
Update pydoc topics and suspicious filters.
2014-03-09 04:12:12 -07:00
09141c4782
Closes #20755 : port sphinx-1.1 fixes from default
2014-02-24 09:35:07 +01:00
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
d8413bab22
merge with 3.3
2014-02-10 22:11:21 +01:00
b38b5c43c7
merge with 3.3
2014-02-10 22:11:21 +01:00
0e25410319
Documentation fixes, including fixing "suspicious" problems.
2014-01-26 00:42:02 -08:00
bcf692417f
doc: pydoc topic and suspicious markup update
2014-01-25 09:15:44 +01:00
2866c6a2a1
merge with 3.3
2014-01-21 19:20:58 +01:00
7ed509a38f
fix deprecated-removed directive with sphinx 1.2
2014-01-21 19:20:31 +01:00
ed007d5b1b
Fix suspicious markup in the docs.
2013-11-24 16:09:26 +01:00
325a1c2f37
Fix markup errors in the docs and amend suspicious ignores.
2013-10-27 09:16:01 +01:00
186729e812
merge with 3.3
2013-10-27 09:54:53 +01:00
33fc6d6040
#4965 : merge with 3.3.
2013-10-14 02:59:54 +03:00
47fd9d8e09
#4965 : Implement intelligent scrolling of the sidebar in the docs.
2013-10-14 02:58:59 +03:00
03d010be14
merge with 3.3
2013-10-13 22:20:08 +02:00
c3a2916919
Closes #19248 : actually check for Python 3.x in tools/sphinx-build.py.
2013-10-13 22:19:49 +02:00
bcdb4fd83c
merge with 3.3
2013-10-13 09:56:24 +02:00
5d5b375c84
Fix a small CSS glitch with deprecated blocks and Sphinx 1.2.
2013-10-13 09:56:20 +02:00
a7bb9b3a13
merge with 3.3
2013-10-13 09:32:00 +02:00
1e32011306
Fix display of deprecated blocks with Sphinx 1.2.
2013-10-13 09:31:42 +02:00
793d8478ee
merge with 3.3
2013-10-12 22:56:37 +02:00
a14034872b
Invert logic of new limited-API annotation and call it "stable ABI".
2013-10-12 22:55:34 +02:00
e9bd31f98f
merge with 3.3
2013-10-12 20:53:53 +02:00
239990daec
Fix compatibility with upcoming Sphinx 1.2.
2013-10-12 20:50:21 +02:00
7c11e52f7e
merge with 3.3
2013-10-12 20:01:14 +02:00
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
f2c64ed9eb
Merge improvements to the suspicious builder and cleanup from 3.3.
2013-03-28 17:46:20 +02:00
a5d55baecc
Update the suspicious builder to detect unused rules, and remove currently unusued rules.
2013-03-28 17:40:24 +02:00
f92b063c4e
Update suspicious ignore file.
2013-03-28 05:12:31 +02:00
e5caf29743
Update suspicious ignore file.
2013-03-28 04:54:58 +02:00
fd4365a4d8
Update suspicious ignore file.
2013-03-28 04:31:53 +02:00
d2685260c4
#4711 : merge with 3.3.
2012-11-03 18:29:31 +02:00
befaac03bb
#4711 : merge with 3.2.
2012-11-03 18:29:16 +02:00
dedfa9bfae
#4711 : break long words in the docs sidebar to avoid overflow.
2012-11-03 18:25:04 +02:00
9e80124ca2
merge with 3.3
2012-10-28 08:00:01 +01:00
ab5da6a80e
merge with 3.2
2012-10-28 07:59:54 +01:00
fffc25da83
#8040 : fix jQuery incompatibility
2012-10-28 07:59:42 +01:00
0f3dae41ef
#8040 : merge with 3.3.
2012-10-27 23:13:34 +03:00
edde409f60
#8040 : merge with 3.2.
2012-10-27 23:13:22 +03:00
e5b1023ae2
#8040 : fix the version.
2012-10-27 23:12:48 +03:00
1543b8c77e
#8040 : merge with 3.3.
2012-10-27 22:11:57 +03:00
8630c1e346
#8040 : merge with 3.2.
2012-10-27 22:11:33 +03:00
380ce651e9
#8040 : add a version switcher to the documentation. Patch by Yury Selivanov.
2012-10-27 22:09:16 +03:00
42ac3c91e7
merge 3.3
2012-10-10 16:49:18 +02:00
83e51f48a8
Issue #12947 : revert earlier workaround and use a monkey-patch to enable showing doctest directives only in the doctest docs.
2012-10-10 16:45:11 +02:00
3a2e101be5
Issue #12947 : revert earlier workaround and use a monkey-patch to enable showing doctest directives only in the doctest docs.
2012-10-10 16:45:11 +02:00
f25dabe1ec
Merge changelog filtering fixes/improvements with 3.3.
2012-10-02 01:46:49 +03:00
7eb03ddf11
Fix/improve the changelog filtering.
2012-10-02 01:43:42 +03:00
a3d6538c12
merge with 3.3
2012-10-01 19:38:41 +02:00
4524b46733
Fix template syntax.
2012-10-01 19:38:34 +02:00
ebe3224747
merge with 3.3
2012-10-01 19:27:25 +02:00
6c4758152f
The default reST role `foo` can now be used in NEWS to refer to Python objects. Use it for a fraction of the current NEWS file.
2012-10-01 19:27:05 +02:00
243729151e
Fix page name.
2012-10-01 19:26:09 +02:00
a32e8dfe12
merge with 3.3.
2012-10-01 19:09:00 +02:00
44d0c2156a
Several improvements to the HTML NEWS version:
...
* rename to "Changelog"
* recognize more issue links
* add NEWS as a dependency for Sphinx
2012-10-01 19:08:50 +02:00
f1d2345842
Merge suspicious ignore file updates with 3.3.
2012-10-01 07:18:55 +03:00
00160661a5
Update suspicious ignore file.
2012-10-01 07:10:08 +03:00
7ef90a1a37
merge with 3.3
2012-09-30 15:10:34 +02:00
2cac28b37e
Add a filterable HTML version of Misc/NEWS to the docs "whatsnew" section.
2012-09-30 15:10:06 +02:00
7d0d57f22c
Doc sidebar: point to 3.4 as dev.
2012-09-30 08:58:21 +02:00
6b5e1d6588
Doc sidebar: point to 3.3 as stable.
2012-09-30 08:57:40 +02:00
26eb110e82
Set up "source" links to point to default branch.
2012-09-29 09:36:04 +02:00
99a247fd01
Merge with main repo default branch.
2012-09-29 09:27:15 +02:00
d6e857b0da
Point "source" links in the docs to the 3.3 versions in the repo.
2012-09-29 09:03:54 +02:00
be54d6d2f3
Update suspicious ignore file.
2012-09-20 08:46:06 +03:00
d183f0be0b
Update pydoc topics and suspicious markup file.
2012-08-25 12:14:59 +02:00
6f69fb145f
Update suspicious ignore file.
2012-08-22 08:38:04 +03:00
a81b481e3a
Fix markup errors and update pydoc topics.
2012-08-11 08:43:59 +02:00
3f81ba88ae
Update suspicious ignore file and pydoc topics.
2012-06-26 09:12:26 +02:00
859aad6a36
Remove packaging from the standard library.
...
Distutils2 will live on on PyPI and be included in the stdlib when it
is ready. See discussion starting at
http://mail.python.org/pipermail/python-dev/2012-June/120430.html
2012-06-24 00:07:41 -04:00
3539afd5c9
Update pydoc topics and fix new suspicious markup.
2012-05-30 22:03:20 +02:00
c31dd2b564
#14405 : merge with 3.2.
2012-05-14 13:32:26 +03:00
e768b06f16
#14405 : remove outdated/broken/duplicate links.
2012-05-14 13:26:45 +03:00
24a05f787e
Include micro version even if it is 0.
2012-05-01 16:27:55 +02:00
ebb29640fa
Suspicious markup check.
2012-05-01 09:29:56 +02:00
d46d69c279
3.2 sidebar: link to 3.3, not 3.1
2012-04-12 19:41:10 +02:00
Ned Deily
Martin Panter
Berker Peksag
Ezio Melotti
Georg Brandl
Victor Stinner
Benjamin Peterson
Martin Panter
Robert Collins
Zachary Ware
Ned Deily
Larry Hastings
Alex Gaynor
Senthil Kumaran
Nick Coghlan
Éric Araujo
Martin v. Löwis