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
87b3caf873
merge with 3.2
2012-03-25 20:41:06 +02:00
d34fc8b275
Add missing files for new doc theme.
2012-03-25 20:40:57 +02:00
288b9bf1ea
merge with 3.2
2012-03-25 20:32:35 +02:00
ab7121430e
Switch to new "lighter" doc design.
2012-03-25 20:31:57 +02:00
846acf5c0c
#14289 : merge with 3.2
2012-03-14 08:18:59 +01:00
525fd5447d
Closes #14289 : put a link to the CHM download page on the docs download page.
2012-03-14 08:18:47 +01:00
0e475c359c
Sort and clean up suspicious ignore file.
2012-03-04 16:22:05 +01:00
a673eb895e
Fix invalid markup and update suspicious ignores.
2012-03-04 16:17:05 +01:00
50fdcdf086
Fix encoding handling of the pydoc-topics writer.
2012-03-04 16:12:02 +01:00
8c5c3c1e33
#14114 : merge with 3.2.
2012-02-25 19:26:39 +02:00
4342722f40
#14114 : don't include copybutton.js in the htmlhelp output.
2012-02-25 19:24:24 +02:00
d120083c14
Issue: #12409 : merge with 3.2
2012-01-16 18:03:51 +01:00
32ee44ffb4
Issue: #12409 : remove obsolete susp-entries
2012-01-16 18:02:09 +01:00
ee090c71b7
merge with 3.2
2012-01-14 22:27:56 +01:00
515687a7ed
remove 'Documenting Python' and its references, it's now on devguide
2012-01-14 22:23:27 +01:00
4d5232ab8a
Merge with 3.2.
2011-12-04 11:51:33 +01:00
6a96a2e1f8
Fix typo.
2011-12-04 11:51:21 +01:00
afe471d7d2
Merge the button to show/hide the prompts and output from 3.2.
2011-10-30 09:37:46 +02:00
f54f6f520d
Add a button to the code examples in the doc to show/hide the prompts and output.
2011-10-30 09:20:19 +02:00
fbd1e041af
Merge with 3.2.
2011-09-04 08:42:26 +02:00
2513123d66
Update suspicious ignore file.
2011-09-03 09:28:05 +02:00
1db1d14e11
Update pydoc topics and suspicious ignore.
2011-08-13 11:33:35 +02:00
2527796a22
Merge from 3.2 ( #10318 , #12255 , #12043 , #12417 and other fixes)
2011-07-29 03:11:09 +02:00
f5e10d1f70
Turn raw URI into real link
2011-07-28 22:50:18 +02:00
bca31b5d1f
#11435 : link to the correct branch.
2011-07-21 09:35:19 +03:00
d3b41c63a6
Fix syntax in packaging docs and update suspicious ignore file.
2011-07-09 11:48:50 +02:00
55729fe718
Packaging doc: Add missing index file, improve main page description.
...
Also promote notices from distutils doc to deprecation boxes.
2011-06-02 15:45:25 +02:00
3a9f58f6b3
Add documentation for the packaging module.
...
This updates the user guide to refer to Packaging instead of Distutils.
Some files still require an update.
2011-06-01 20:42:49 +02:00
fb2473fc8b
Merge 3.2.1rc1 release changes to default.
2011-05-21 19:43:36 +02:00
521143dd6c
Update pydoc topics and handle suspicious markup.
2011-05-15 17:51:24 +02:00
da71013c11
Update suspicious ignore file.
2011-05-08 09:10:29 +02:00
1a87e3211a
#11435 : Update the links generated by the source directive to use hg.python.org.
2011-03-11 15:16:01 +02:00
f0eccfd010
#11435 : Merge with 3.2
2011-03-11 15:17:25 +02:00
97b67216d5
3.2 is stable now.
2011-02-21 18:37:01 +00:00
14927d0928
Topic and suspicious update.
2011-02-20 10:22:41 +00:00
829befb9e3
Fix markup error and update suspicious ignores.
2011-02-13 09:59:39 +00:00
6ddc16b41e
Update suspicious ignore file.
2011-01-30 14:02:36 +00:00
f3923cf9fd
Suppress trailing spaces in table paragraphs.
2011-01-19 08:42:03 +00:00
23e924f96b
Fix "make suspicious" errors and update ignore file.
2011-01-15 17:05:20 +00:00
ee31e31db3
Add semicolon for consistency.
2011-01-13 07:24:40 +00:00
183fe81f8f
#10130 : Prepare for building epub-format docs.
2011-01-05 11:00:25 +00:00
069149155b
Fix duplicate end tag.
2011-01-05 10:59:48 +00:00
c88435023c
Fix markup error and update suspicious file.
2010-12-19 10:28:46 +00:00
bccb8be262
Update suspicious exceptions.
2010-12-04 19:06:14 +00:00
09b0b3a655
issue10622: fix superflous scrollbar on the right side of <pre> boxes in the
...
generated html docs. visible in chrome, possibly other webkit browsers.
2010-12-04 11:36:58 +00:00
faed5b5132
Add CSS rule for the deprecated-removed directive
2010-11-21 20:27:39 +00:00
ac12787075
Ignore suspicious-ignore file.
2010-11-13 06:38:37 +00:00
281d6ba5fa
Add a deprecated-removed directive that allows to give the version of removal for deprecations.
2010-11-12 08:57:12 +00:00
6881886389
#10334 : add a role to refer to Python source files in SVN.
2010-11-06 07:19:35 +00:00
5c66bcaa1a
Fix markup error and update false positive entries from "make suspicious".
2010-10-29 05:36:28 +00:00
a17fd1f3b5
Port suspicious markup builder and patchlevel.py so that they can be used with Python 2 and 3 without conversion.
2010-10-29 05:30:17 +00:00
19b3e00627
Fix the suspicious builder not to write CRLF, update suspicious file and add instructions to Makefile.
2010-10-06 10:35:24 +00:00
8d58216050
More inclusive title.
2010-09-03 22:33:27 +00:00
ccb90e3ccd
Keep contents order the same between versions.
2010-09-02 09:17:31 +00:00
6cb5ad035b
#9677 : fix link.
2010-09-01 21:02:50 +00:00
a09dc9e38a
'Using Python' now called 'Python Setup'
2010-09-01 20:31:59 +00:00
f5a3d699a7
add nonlocal to pydoc topics #9724
2010-08-31 14:31:01 +00:00
2f27755f5d
Get rid of UserWarnings when running Sphinx from tools dir.
2010-08-03 12:31:59 +00:00
80ff2adf88
Update pydoc topics and adapt Topics builder to Sphinx 1.0.
2010-07-31 08:27:46 +00:00
8a1caa2361
#6522 : add a "decorator" directive to explicitly document decorators, and use it in a few places.
2010-07-29 16:01:11 +00:00
02053ee3b9
#9279 : remove the pdb.doc file, put its contents in pdb.__doc__. Also sync this and the pdb docs, introduce a new directive for pdb commands and a role to link to them.
2010-07-18 10:11:03 +00:00
facb0e9a76
2.7 is now stable.
2010-07-09 07:33:15 +00:00
4833e5b874
Remove the need for a "()" empty argument list after opcodes.
2010-07-03 10:41:33 +00:00
0d31d58c15
bltn-file-objects don't exist in python3
2010-06-06 02:44:41 +00:00
582c0a6ac2
Merged revisions 80388 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r80388 | georg.brandl | 2010-04-23 00:15:33 +0200 (Fr, 23 Apr 2010) | 1 line
Add "report a bug" links in some prominent places. Make it clear that doc bugs can be mailed to docs@python.org . Clarify tracker usage.
........
2010-04-22 23:20:19 +00:00
49f471836a
Merged revisions 78921 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r78921 | georg.brandl | 2010-03-13 14:39:46 +0100 (Sa, 13 Mär 2010) | 1 line
Change/fix handling of docs download location: for daily builds, put them right next to the HTML.
........
2010-03-13 13:42:16 +00:00
420ca77e73
Make tool compatible with 2.x and 3.x.
2010-03-12 10:04:37 +00:00
90f5ba538b
convert shebang lines: python -> python3
2010-03-11 22:53:45 +00:00
f08adb36d8
don't say that 3.2 is another version
2009-11-21 23:54:32 +00:00
495f7b5adb
Merged revisions 75365,75394,75402-75403,75418,75459,75484,75592-75596,75600,75602-75607,75610-75613,75616-75617,75623,75627,75640,75647,75696,75795 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r75365 | georg.brandl | 2009-10-11 22:16:16 +0200 (So, 11 Okt 2009) | 1 line
Fix broken links found by "make linkcheck". scipy.org seems to be done right now, so I could not verify links going there.
........
r75394 | georg.brandl | 2009-10-13 20:10:59 +0200 (Di, 13 Okt 2009) | 1 line
Fix markup.
........
r75402 | georg.brandl | 2009-10-14 17:51:48 +0200 (Mi, 14 Okt 2009) | 1 line
#7125 : fix typo.
........
r75403 | georg.brandl | 2009-10-14 17:57:46 +0200 (Mi, 14 Okt 2009) | 1 line
#7126 : os.environ changes *do* take effect in subprocesses started with os.system().
........
r75418 | georg.brandl | 2009-10-14 20:48:32 +0200 (Mi, 14 Okt 2009) | 1 line
#7116 : str.join() takes an iterable.
........
r75459 | georg.brandl | 2009-10-17 10:57:43 +0200 (Sa, 17 Okt 2009) | 1 line
Fix refleaks in _ctypes PyCSimpleType_New, which fixes the refleak seen in test___all__.
........
r75484 | georg.brandl | 2009-10-18 09:58:12 +0200 (So, 18 Okt 2009) | 1 line
Fix missing word.
........
r75592 | georg.brandl | 2009-10-22 09:05:48 +0200 (Do, 22 Okt 2009) | 1 line
Fix punctuation.
........
r75593 | georg.brandl | 2009-10-22 09:06:49 +0200 (Do, 22 Okt 2009) | 1 line
Revert unintended change.
........
r75594 | georg.brandl | 2009-10-22 09:56:02 +0200 (Do, 22 Okt 2009) | 1 line
Fix markup.
........
r75595 | georg.brandl | 2009-10-22 09:56:56 +0200 (Do, 22 Okt 2009) | 1 line
Fix duplicate target.
........
r75596 | georg.brandl | 2009-10-22 10:05:04 +0200 (Do, 22 Okt 2009) | 1 line
Add a new directive marking up implementation details and start using it.
........
r75600 | georg.brandl | 2009-10-22 13:01:46 +0200 (Do, 22 Okt 2009) | 1 line
Make it more robust.
........
r75602 | georg.brandl | 2009-10-22 13:28:06 +0200 (Do, 22 Okt 2009) | 1 line
Document new directive.
........
r75603 | georg.brandl | 2009-10-22 13:28:23 +0200 (Do, 22 Okt 2009) | 1 line
Allow short form with text as argument.
........
r75604 | georg.brandl | 2009-10-22 13:36:50 +0200 (Do, 22 Okt 2009) | 1 line
Fix stylesheet for multi-paragraph impl-details.
........
r75605 | georg.brandl | 2009-10-22 13:48:10 +0200 (Do, 22 Okt 2009) | 1 line
Use "impl-detail" directive where applicable.
........
r75606 | georg.brandl | 2009-10-22 17:00:06 +0200 (Do, 22 Okt 2009) | 1 line
#6324 : membership test tries iteration via __iter__.
........
r75607 | georg.brandl | 2009-10-22 17:04:09 +0200 (Do, 22 Okt 2009) | 1 line
#7088 : document new functions in signal as Unix-only.
........
r75610 | georg.brandl | 2009-10-22 17:27:24 +0200 (Do, 22 Okt 2009) | 1 line
Reorder __slots__ fine print and add a clarification.
........
r75611 | georg.brandl | 2009-10-22 17:42:32 +0200 (Do, 22 Okt 2009) | 1 line
#7035 : improve docs of the various <method>_errors() functions, and give them docstrings.
........
r75612 | georg.brandl | 2009-10-22 17:52:15 +0200 (Do, 22 Okt 2009) | 1 line
#7156 : document curses as Unix-only.
........
r75613 | georg.brandl | 2009-10-22 17:54:35 +0200 (Do, 22 Okt 2009) | 1 line
#6977 : getopt does not support optional option arguments.
........
r75616 | georg.brandl | 2009-10-22 18:17:05 +0200 (Do, 22 Okt 2009) | 1 line
Add proper references.
........
r75617 | georg.brandl | 2009-10-22 18:20:55 +0200 (Do, 22 Okt 2009) | 1 line
Make printout margin important.
........
r75623 | georg.brandl | 2009-10-23 10:14:44 +0200 (Fr, 23 Okt 2009) | 1 line
#7188 : fix optionxform() docs.
........
r75627 | fred.drake | 2009-10-23 15:04:51 +0200 (Fr, 23 Okt 2009) | 2 lines
add further note about what's passed to optionxform
........
r75640 | neil.schemenauer | 2009-10-23 21:58:17 +0200 (Fr, 23 Okt 2009) | 2 lines
Improve some docstrings in the 'warnings' module.
........
r75647 | georg.brandl | 2009-10-24 12:04:19 +0200 (Sa, 24 Okt 2009) | 1 line
Fix markup.
........
r75696 | georg.brandl | 2009-10-25 21:25:43 +0100 (So, 25 Okt 2009) | 1 line
Fix a demo.
........
r75795 | georg.brandl | 2009-10-27 16:10:22 +0100 (Di, 27 Okt 2009) | 1 line
Fix a strange mis-edit.
........
2009-10-27 15:28:25 +00:00
Larry Hastings
Nick Coghlan
Georg Brandl
Ezio Melotti
Éric Araujo
Martin v. Löwis
Sandro Tosi
Gregory P. Smith
Raymond Hettinger
Benjamin Peterson