[docs] Which version of sphinx?

Tshepang Lekhonkhobe tshepang at gmail.com
Thu Feb 23 15:48:11 CET 2012


On Thu, Feb 23, 2012 at 10:42, Tshepang Lekhonkhobe <tshepang at gmail.com> wrote:
> On Thu, Aug 18, 2011 at 14:45, Sandro Tosi <sandro.tosi at gmail.com> wrote:
>> On Sat, Jun 11, 2011 at 01:27, Tshepang Lekhonkhobe <tshepang at gmail.com> wrote:
>>> On Fri, 2011-06-10 at 20:40 +0000, Sandro Tosi wrote:
>>>> Hello Tshepang,
>>>>
>>>> On Thu, Jun 2, 2011 at 23:56, Tshepang Lekhonkhobe <tshepang at gmail.com> wrote:
>>>> > Hi,
>>>> >
>>>> > Is there any reason Sphinx version was specified here:
>>>> > http://docs.python.org/dev/documenting/building.html?
>>>>
>>>> I don't have that clear your question. Are you asking why the version
>>>> is explict in this command:
>>>>
>>>> svn co http://svn.python.org/projects/external/Sphinx-0.6.5/sphinx tools/sphinx
>>>>
>>>> or in some other place? can you please be a bit more specific (either
>>>> in what you think is wrong and how you'd fix it)?
>>>
>>> Sorry for not being too clear. I meant, why is that specific version
>>> required? Why doesn't the link just point to trunk (or tip, in Mercurial
>>> speak)?
>>
>> I can think mainly two reason:
>>
>> - stability: if everyone is building the docs from sphinx tip (and all
>> other third-party tool) you'll get a mess where for some people the
>> change works and for others doesn't. Having "written in stone" what's
>> the version to use, avoid this ambiguity.
>
> Indeed. Version 1.0.8 (as packaged in Debian) actually breaks the
> build. I prepared a whole patch to fix the issues, only to discover
> that the version specified there (0.6.5) had no issues. I will attach
> the patch here, one that makes the documentation to build with version
> 1.0.8, just in case.

Okay, the docs are outdated. Running "cd Doc && make html" pulls and
uses Sphinx 1.0.7.


More information about the docs mailing list