[Distutils] docs/ vs doc/
barry at python.org
Thu Feb 24 00:10:06 CET 2011
On Feb 19, 2011, at 12:57 AM, Éric Araujo wrote:
>Old thread revival! I was going through my archive and noticed this
>unanswered message from late September which prompted me to do a bit of
>>>>> However, upload_docs
>>>>> never quite works out of the box for me anyway. First, it insists
>>>>> on an index.html file, which my Sphinx builds never seem to write,
>>>>> so I always have to add a symlink.
>>> Barry, do you mean that you have all files generated by Sphinx but not
>>> index.html ? That's weird, Sphinx should generate it like the others.
>> Except that I don't have an index.txt file. It kind of doesn't make sense. I
>> use buildout and have this in my buildout.cfg:
>> recipe = z3c.recipe.sphinxdoc
>> eggs = mailman [docs]
>> index-doc = docs/README
>> default.css =
>> layout.html =
>> extensions = sphinxconf
>> So what I end up doing is symlinking index.html to README.html before I
>I don’t know the recipe, but the “index-doc” settings clearly looks like
>something that controls what the master page is called. I guess it’s
>because you want your README file to serve double duty as Sphinx front
>page. Now for the good news: I found you a way to make Sphinx use that
>file as index.html:
Thanks, but I tried this and couldn't get it working. Actually, from Georg's
response, it sounds like html_index isn't even supported any more.
My own crappy workaround is this bit of ugliness in my conf.py file:
cwd = os.getcwd()
print 'index.html -> README.html'
The interesting thing is that this works with 'python setup.py build_sphinx'
but not with 'make html' (using Sphinx's generated Makefile) because of the
different build path defaults. OTOH, the Makefile does have this nice target:
(cd _build/html; \
rm -f index.html; \
ln -s README.html index.html; \
zip -r ../pypi .)
So 'make html && make pypi' leaves you with _build/pypi.zip that should be
>One may argue that upload_docs should just bundle *.html files, without
>imposing the existence of index.html; I think the check is useful.
>>>> Second, it doesn't seem to play nicely with the location
>>>>> that my buildout-based builds puts the docs, so I always also have
>>>>> to use --upload-dir. Yes, it would be nice if both of these
>>>>> problems were fixed too. Yes, I should report them as bugs (or just
>>>>> fix 'em ;).
>>> How would you fix the second issue ? e.g. if the docs is not in docs/
>>> or doc/
>> That's a good question! Maybe it's a buildout or recipe issue?
>You can make the upload-dir setting persistent by putting it in your
>setup.cfg. Or if the recipe is used by a large part of the community,
>open a feature request to have this directory automatically found if
>neither docs nor doc exist. What is the directory path, btw?
Yep, I found the upload-dir setting for setup.cfg. So after 'make pypi' a
'python setup.py upload_docs' DTRT.
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 836 bytes
Desc: not available
More information about the Distutils-SIG