From robin at nibor.org Sat Sep 1 22:41:39 2007 From: robin at nibor.org (Robin Stocker) Date: Sat, 01 Sep 2007 22:41:39 +0200 Subject: [Doc-SIG] [PATCH] New documentation: headerlink style speed issue Message-ID: <46D9CE83.6010003@nibor.org> 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 -------------- next part -------------- An embedded and charset-unspecified text was scrubbed... Name: headerlink-style-speed.patch Url: http://mail.python.org/pipermail/doc-sig/attachments/20070901/58d312b6/attachment.txt From g.brandl at gmx.net Sat Sep 1 23:49:37 2007 From: g.brandl at gmx.net (Georg Brandl) Date: Sat, 01 Sep 2007 23:49:37 +0200 Subject: [Doc-SIG] [PATCH] New documentation: headerlink style speed issue In-Reply-To: <46D9CE83.6010003@nibor.org> References: <46D9CE83.6010003@nibor.org> Message-ID: Robin Stocker schrieb: > 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? Yes, thank you very much! It's committed as rev. 57898 and will go live on docs.python.org within 12 hours' time. Cheers, Georg -- Thus spake the Lord: Thou shalt indent with four spaces. No more, no less. Four shall be the number of spaces thou shalt indent, and the number of thy indenting shall be four. Eight shalt thou not indent, nor either indent thou two, excepting that thou then proceed to four. Tabs are right out. From ndbecker2 at gmail.com Wed Sep 5 14:57:06 2007 From: ndbecker2 at gmail.com (Neal Becker) Date: Wed, 05 Sep 2007 08:57:06 -0400 Subject: [Doc-SIG] python sphinx install? Message-ID: 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? From ndbecker2 at gmail.com Wed Sep 5 15:18:29 2007 From: ndbecker2 at gmail.com (Neal Becker) Date: Wed, 05 Sep 2007 09:18:29 -0400 Subject: [Doc-SIG] python sphinx install? References: Message-ID: 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? From the.blue.valkyrie at gmail.com Mon Sep 10 23:57:17 2007 From: the.blue.valkyrie at gmail.com (=?ISO-8859-1?Q?Cristina_Yenyxe_Gonz=E1lez_Garc=EDa?=) Date: Mon, 10 Sep 2007 23:57:17 +0200 Subject: [Doc-SIG] Bdb documentation (patch) Message-ID: 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 at 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 -------------- next part -------------- An HTML attachment was scrubbed... URL: http://mail.python.org/pipermail/doc-sig/attachments/20070910/73fbdc0b/attachment.htm From g.brandl at gmx.net Tue Sep 11 12:27:26 2007 From: g.brandl at gmx.net (Georg Brandl) Date: Tue, 11 Sep 2007 12:27:26 +0200 Subject: [Doc-SIG] Bdb documentation (patch) In-Reply-To: References: Message-ID: Cristina Yenyxe Gonz?lez Garc?a schrieb: > 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 at python, please tell me and I'll do with as soon as > possible :) No need for this, I've already noticed it and the doc team will proofread and then commit it. Thanks! Georg From andre.roberge at gmail.com Wed Sep 12 23:13:00 2007 From: andre.roberge at gmail.com (Andre Roberge) Date: Wed, 12 Sep 2007 18:13:00 -0300 Subject: [Doc-SIG] Missing a builtin in python 3.0 docs Message-ID: <7528bcdd0709121413t6d59507cl70a515057f89b820@mail.gmail.com> 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 ;-) From g.brandl at gmx.net Wed Sep 12 23:30:58 2007 From: g.brandl at gmx.net (Georg Brandl) Date: Wed, 12 Sep 2007 23:30:58 +0200 Subject: [Doc-SIG] Missing a builtin in python 3.0 docs In-Reply-To: <7528bcdd0709121413t6d59507cl70a515057f89b820@mail.gmail.com> References: <7528bcdd0709121413t6d59507cl70a515057f89b820@mail.gmail.com> Message-ID: Andre Roberge schrieb: > 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 ;-) You're totally right. I now copied the docs for old raw_input() to 3k as input(). Georg