Commit Graph

360 Commits

Author SHA1 Message Date
Mariatta 814213bdf1 [3.6] Backport README.rst changes (GH-294)
(cherry picked from commit b3f1f59cf4)
(cherry picked from commit 1b3d88eb33)
(cherry picked from commit c0866855d5)
(cherry picked from commit e32ec9334b)
(cherry picked from commit 6329aea78e)
2017-02-25 11:56:48 -08:00
Victor Stinner b300c660d3 Backport36 doc fixes: PR#68 and PR#124 (#125)
* Travis CI: run rstlint.py in the docs job (#68)

Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.
(cherry picked from commit 2b501866ed)

* Doc/Makefile: set PYTHON to python3 (#124)

rstlint.py run by "make check" doesn't support Python 2.

"make venv" runs "$(PYTHON) -m venv", whereas Python 2 doens't
provide the venv module: it's a module of Python 3 standard library.

(cherry picked from commit 91b0e7d0ca)
2017-02-16 00:56:54 +01:00
Mariatta 9268855ba6 Fix some sphinx warnings (#9) (#81)
* Fix some deprecation warnings in Doc/conf.py
* Fix an rst error in Misc/NEWS

Contributed by Ryan Gonzalez @kirbyfan64

(cherry picked from commit e7ffb99f84)
2017-02-14 06:11:48 -08:00
Victor Stinner 33bb64fb30 Merge 3.5 2016-10-18 15:48:14 +02:00
Victor Stinner 9f2e377beb Issue #27896: Allow passing sphinx options to Doc/Makefile
Patch written by Julien Palard.
2016-10-16 19:14:23 +02:00
Georg Brandl d20cb0263a merge with 3.5 2016-06-15 08:58:46 +02:00
Georg Brandl b14f0c6409 merge with 3.4 2016-06-15 08:58:00 +02:00
Georg Brandl 4b9e75ba7f Docs: add html-stable autobuild variant 2016-06-15 08:57:32 +02:00
Zachary Ware bfba2cd406 Don't doc check the venv dir 2016-03-24 22:44:41 -05:00
Larry Hastings e8ff0caa72 Regenerated pydoc topic index in preparation for Python 3.5.0b2. 2015-05-30 16:58:27 -07:00
Benjamin Peterson 649e1f141a merge 3.4 2014-12-10 11:05:35 -05:00
Benjamin Peterson 82c05a54a2 fix path to patchlevel.py 2014-12-10 11:04:17 -05:00
Brett Cannon d5ea39d1b8 Issue #22394: Add a 'venv' command to Doc/Makefile.
This will create a venv using the interpreter specified by the PYTHON
variable for the Makefile that also install Sphinx. Typical usage is
expected to be:

  cd Doc
  make venv PYTHON=../python
  make html PYTHON=venv/bin/python3
2014-12-05 15:17:31 -05: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 2b1a0a30c9 Dont define an empty SPHINXOPTS, which overrides a definition from the environment. 2014-09-30 22:23:57 +02:00
Benjamin Peterson efd713b82b allow archives for rc releases to be built (closes #22484) 2014-09-24 20:22:24 -04: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
Serhiy Storchaka 17f5f817de Issue #15759: "make suspicious", "make linkcheck" and "make doctest" in Doc/
now display special message when and only when there are failures.
2014-07-22 10:24:25 +03:00
Zachary Ware 9393fffa5f Issue #17386: List the 'htmlview' target in the Doc/Makefile help output. 2014-04-29 09:24:40 -05:00
Georg Brandl 865bdbf4af Doc: do not compress .epub for dist, it is already zipped. 2014-03-28 19:48:55 +01:00
Éric Araujo f446d7a70b Remove references to make targets deleted in eef7899ea7ab 2014-03-13 19:30:43 -04: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 8bd656ddb8 Closes #20258: Sphinx toolchain: move back to Jinja2 2.3.1 with support for Py2.5. 2014-01-14 12:00:45 +01:00
Georg Brandl 5636eb7b93 Update Sphinx toolchain. 2014-01-11 20:04:19 +01:00
Georg Brandl 44d2429a25 Doc/Makefile: also do "make suspicious" during daily autobuild 2013-11-24 16:17:54 +01:00
Georg Brandl 01f47e82a3 Add a autobuild-quick target that only rebuilds HTML. 2012-10-28 08:09:02 +01:00
Ezio Melotti fe71bb52e4 #8040: merge with 3.2. 2012-10-27 22:29:50 +03:00
Ezio Melotti 58864b3cad #8040: enable the versionswitcher for the autobuild-dev target. 2012-10-27 22:28:48 +03:00
Georg Brandl 0472bc8709 Use newer version of Pygments that handles "yield from". 2012-09-30 18:00:50 +02:00
Georg Brandl 7f3cd98beb Fix target path in message. 2011-07-03 09:30:42 +02:00
Georg Brandl 6dc50f34dd Update to 1.0.7. 2011-01-15 16:45:03 +00:00
Georg Brandl 183fe81f8f #10130: Prepare for building epub-format docs. 2011-01-05 11:00:25 +00:00
Georg Brandl cfa8e29d1c Switch to Sphinx 1.0.5. 2010-11-12 08:09:11 +00:00
Georg Brandl 5ad8ed5f26 Update to Sphin 1.0.4. 2010-10-06 12:29:49 +00:00
Georg Brandl 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
Éric Araujo 716ac385d9 Revert accidental commit, apologies for the noise 2010-09-06 01:31:11 +00:00
Éric Araujo f63a6fc24e Update 2010-09-06 01:27:06 +00:00
Georg Brandl 38557f2ac9 A couple of nits how to ignore errors. 2010-08-03 12:36:57 +00:00
Georg Brandl 4bf70686fa Update Sphinx to 1.0.1. 2010-07-27 18:19:21 +00:00
Georg Brandl 6b0e0e41b8 Update to 1.0. 2010-07-23 16:55:42 +00:00
Georg Brandl 692b3f8035 Silence makeindex. 2010-07-11 08:33:16 +00:00
Georg Brandl 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
Georg Brandl fe427fee6c Merged revisions 78908 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r78908 | georg.brandl | 2010-03-13 11:12:39 +0100 (Sa, 13 Mär 2010) | 1 line

  Add Makefile targets for automatic doc build.  Add script that will be used for daily build.
........
2010-03-13 11:02:07 +00:00
Georg Brandl d94b4a75e8 Merged revisions 78910 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r78910 | georg.brandl | 2010-03-13 11:54:12 +0100 (Sa, 13 Mär 2010) | 1 line

  Bump externals versions for doc build.
........
2010-03-13 10:56:09 +00:00
R. David Murray e821cb6f24 Merged revisions 78416,78430 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r78416 | dirkjan.ochtman | 2010-02-23 23:12:11 -0500 (Tue, 23 Feb 2010) | 1 line

  Issue #8004: add a serve target to the Doc Makefile.
........
  r78430 | dirkjan.ochtman | 2010-02-24 12:06:31 -0500 (Wed, 24 Feb 2010) | 1 line

  Add some notes about Tools/scripts/serve.py.
........
2010-03-08 17:48:38 +00:00
Benjamin Peterson b05e73d9c8 Merged revisions 77151-77152 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r77151 | georg.brandl | 2009-12-30 12:32:50 -0600 (Wed, 30 Dec 2009) | 1 line

  #7487: update Pygments version.
........
  r77152 | georg.brandl | 2009-12-30 12:36:09 -0600 (Wed, 30 Dec 2009) | 1 line

  #7602: improve "clean" and "checkout" targets now that all tools are in externals.
........
2009-12-31 03:35:15 +00:00
Georg Brandl 9abe1f1159 Merged revisions 77145 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r77145 | georg.brandl | 2009-12-30 17:21:26 +0100 (Mi, 30 Dez 2009) | 1 line

  Use new Pygments version.
........
2009-12-30 16:24:25 +00:00
Benjamin Peterson 864b3f08d8 Merged revisions 76255 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r76255 | benjamin.peterson | 2009-11-13 17:11:54 -0600 (Fri, 13 Nov 2009) | 1 line

  use Sphinx 0.6.3
........
2009-11-13 23:14:24 +00:00
Benjamin Peterson 0a3faef5f2 Merged revisions 73669 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r73669 | benjamin.peterson | 2009-06-28 22:30:55 -0500 (Sun, 28 Jun 2009) | 1 line

  update to sphinx 0.6.2
........
2009-06-29 03:37:21 +00:00
Georg Brandl 5617db86c3 Merged revisions 71960 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r71960 | georg.brandl | 2009-04-26 11:56:44 +0200 (So, 26 Apr 2009) | 1 line

  Move pydoc_topics module to its own subdirectory, so that no generated code is in Lib/.
........
2009-04-27 16:28:57 +00:00