Mailman 3 September 2007 - Doc-SIG

Missing a builtin in python 3.0 docs
by Andre Roberge Sept. 12, 2007

Sept. 12, 2007

Sorry to be a pest about input/raw_input... On page http://docs.python.org/dev/3.0/library/functions.html the input() builtin [the old raw_input()] is not listed. André, who'd like PEP 3111 to be not totally forgotten ;-)

2 1

Bdb documentation (patch)
by Cristina Yenyxe González García Sept. 11, 2007

Sept. 11, 2007

Hello to all the list members, I've recently sent a documentation patch for the bdb module to the Python Tracker (the direct link is http://bugs.python.org/issue1136 ) because I saw it keeps undocumented in Python 2.6 and 3.0 alphas, but then I discovered it could be better writing to this list. If I should send it to docs@python, please tell me and I'll do with as soon as possible :) Of course, if you have any comment about a document improvement, it will be welcomed. I wish to help in some way. Greetings, Cristina

2 1

Re: [Doc-SIG] python sphinx install?
by Neal Becker Sept. 5, 2007

Sept. 5, 2007

Georg Brandl wrote: > Neal Becker schrieb: >> I'm interested in trying out new style (python 2.6) documentation. I see >> we're using docutils + sphinx? >> >> I did: svn co http://svn.python.org/projects/doctools/trunk/ >> >> How can I install this to try it with python-2.5? > > What do you want to try with Python 2.5? > > If you want to build the Python 2.6/3.0 docs, it's easiest to check the > Python sources out from http://svn.python.org/projects/python/trunk, go to > the Doc directory and do "make html". This will checkout sphinx and all > other needed libraries into Doc/tools and build the docs. > > Georg > I want to document my own python code. I figured I might as well start using the new documentation system - but I'm using python-2.5. I intend to use epydoc. I thought maybe I could just add sphinx to my docutils, but maybe not?

1 0

python sphinx install?
by Neal Becker Sept. 5, 2007

Sept. 5, 2007

I'm interested in trying out new style (python 2.6) documentation. I see we're using docutils + sphinx? I did: svn co http://svn.python.org/projects/doctools/trunk/ How can I install this to try it with python-2.5?

1 0

[PATCH] New documentation: headerlink style speed issue
by Robin Stocker Sept. 1, 2007

Sept. 1, 2007

Hi, Browsing the (very pretty) new documentation with Firefox, I noticed that selecting text was slow, especially on large pages. For example, on the module index page, it could take up to 1 second until the blue selection background would appear after I had selected some text with the mouse. I figured it could have something to do with the style sheet and by commenting out various parts of default.css, I narrowed the cause down to this: *:hover > a.headerlink, *:hover > a.headerlink, *:hover > a.headerlink, *:hover > a.headerlink, *:hover > a.headerlink, *:hover > a.headerlink { visibility: visible; } Most likely the problem is with the *:hover quantifier. When the mouse hovers over any element, Firefox has to check if there's a a.headerlink in the element. After changing *:hover to the specific elements h1-h6 and dt (are these all?), text selection is as smooth as it should be and maybe even overall display speed is better. Attached is a patch for this, which also removes some (unnecessary?) duplication. What do you think, could you commit the patch? Robin Index: sphinx/style/default.css =================================================================== --- sphinx/style/default.css (revision 57882) +++ sphinx/style/default.css (working copy) @@ -529,11 +529,6 @@ div.body h5 { font-size: 110%; } div.body h6 { font-size: 100%; } -a.headerlink, -a.headerlink, -a.headerlink, -a.headerlink, -a.headerlink, a.headerlink { color: #c60f0f; font-size: 0.8em; @@ -542,20 +537,16 @@ visibility: hidden; } -*:hover > a.headerlink, -*:hover > a.headerlink, -*:hover > a.headerlink, -*:hover > a.headerlink, -*:hover > a.headerlink, -*:hover > a.headerlink { +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { visibility: visible; } -a.headerlink:hover, -a.headerlink:hover, -a.headerlink:hover, -a.headerlink:hover, -a.headerlink:hover, a.headerlink:hover { background-color: #c60f0f; color: white;

2 1