Repository navigation
Small bat files to build docs on Windows #45813
Description
| BPO | 1472 |
|---|---|
| Nosy | @loewis, @birkenfeld, @amauryfa, @tiran |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = <Date 2008-01-18.12:00:32.292>
created_at = <Date 2007-11-20.03:27:34.178>
labels = ['type-feature', 'OS-windows']
title = 'Small bat files to build docs on Windows'
updated_at = <Date 2008-01-18.12:00:32.291>
user = 'https://github.com/tiran'bugs.python.org fields:
activity = <Date 2008-01-18.12:00:32.291>
actor = 'christian.heimes'
assignee = 'none'
closed = True
closed_date = <Date 2008-01-18.12:00:32.292>
closer = 'christian.heimes'
components = ['Windows']
creation = <Date 2007-11-20.03:27:34.178>
creator = 'christian.heimes'
dependencies = []
files = ['8784']
hgrepos = []
issue_num = 1472
keywords = ['patch']
message_count = 13.0
messages = ['57690', '57692', '59264', '59682', '59714', '59717', '59718', '59721', '59733', '59820', '59826', '59856', '60088']
nosy_count = 5.0
nosy_names = ['loewis', 'georg.brandl', 'amaury.forgeotdarc', 'christian.heimes', 'JosephArmbruster']
pr_nums = []
priority = 'low'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue1472'
versions = ['Python 2.6', 'Python 3.0']
Activity
tiran commentedon Nov 20, 2007
I've created a small bat files that mimics the Makefile in Docs/. It may
be useful for some Windows users.
loewis commentedon Nov 20, 2007
See also Tools/buildbot/buildmsi.bat. With cygwin installed, building
the documentation is as simple as
bash.exe -c 'cd Doc;make PYTHON=python2.5 update htmlhelp'
"%ProgramFiles%\HTML Help Workshop\hhc.exe" Doc\build\htmlhelp\pydoc.hhp
JosephArmbruster commentedon Jan 4, 2008
I tested this out out in the trunk (59706). Placed builddoc.bat in /Doc
and ran the following commands:
builddoc checkout
builddoc html
builddoc htmlhelp
builddoc web
All appeared to work fine on my system.
amauryfa commentedon Jan 10, 2008
This batch file is a good idea. I have two remarks:
it assumes that the python program is spelled "python25".
This could be configurable. Something along:
IF "%PYTHON%"=="" SET PYTHON=python25
Or is there a better way?
Also, I suggest to insert a
SETLOCAL
command on the second line of the script, so that the variables set in
the script are restored at the end.
JosephArmbruster commentedon Jan 11, 2008
Is referencing the built python binary in the build tree a good idea?
Just in case they do not have python installed on the system already?
tiran commentedon Jan 11, 2008
Joseph Armbruster wrote:
The doc builder requires Python 2.5 and *may* work with 2.6 but
definitely not with 3.x.
JosephArmbruster commentedon Jan 11, 2008
Ah, good to know :-)
birkenfeld commentedon Jan 11, 2008
Christian Heimes schrieb:
It should work with 2.6 without problems.
3k compatibility is another story, of course :)
JosephArmbruster commentedon Jan 11, 2008
Which brings up a question. Would all things in the tree ideally work
with the version that was built from checkout? Just in case something
like this comes up in the future, i'd want to know if it is better to
have it configured as this or to auto-magically point to the "right
place" in the build tree for the python binary.
Curiosity more than anything.
birkenfeld commentedon Jan 12, 2008
Ideally, yes. The case of the doc build is a bit more complicated
because it relies on external libraries which may or may not work with
the tree version.
loewis commentedon Jan 12, 2008
It's more important that it works with many old versions,
than with its own version. "python" should be on the path,
and ideally, whatever you get there should work.
The documentation, unfortunately, requires 2.5 as a minimum.
It should stay that way for a long time, so that at some
point, it works with whatever people typically have on their
machines.
birkenfeld commentedon Jan 13, 2008
FTR, I'm currently removing all 2.5isms from Sphinx.
tiran commentedon Jan 18, 2008
I've implemented Amaury's suggestions and also added a call to hhc.exe
if the target is htmlhelp. The files was added in r60048