Re: [Distutils] [Catalog-sig] HTML in long description
On Fri, 21 Aug 2009 08:05:47 -0700, Martin v. Löwis
It might also be useful to have a distutils command that generates a pypi-like page, so that people can preview the rendered description.
I often think: why not integrate Sphinx with PyPI's web page generation?
Perhaps a sphinx extension that would generate the "front page" for PyPI
containing long_description and download links along with other pertinent
metadata. Then, this "preview" functionality can be flexibly added to
distutils (which would delegate to Sphinx anyway).
Additionally, the entire documentation can also be attached to a PyPI
page, for instance:
http://pypi.python.org/pypi/Distribute would be the "front page"
and:
http://pypi.python.org/pypi/Distribute/docs/api can be the api docs
The same URL structure can be made available in the local preview
(http://localhost:8800/pypi/Distribute/docs/api).
I often think: why not integrate Sphinx with PyPI's web page generation? Perhaps a sphinx extension that would generate the "front page" for PyPI containing long_description and download links along with other pertinent metadata. Then, this "preview" functionality can be flexibly added to distutils (which would delegate to Sphinx anyway).
Additionally, the entire documentation can also be attached to a PyPI page, for instance:
http://pypi.python.org/pypi/Distribute would be the "front page"
and:
http://pypi.python.org/pypi/Distribute/docs/api can be the api docs
The same URL structure can be made available in the local preview (http://localhost:8800/pypi/Distribute/docs/api ).
Hmm, why not merge bitbucket and PyPI (w/ sphinx, Distribute)? One stop Python development!
A lot less radical and working today: http://pypi.python.org/pypi/Sphinx-PyPI-upload which will add an upload_sphinx command to (setuptools based) setup.py, creates a zip file of your Sphinx build directory and uploads it to PyPI to show up at http://packages.python.org/ <package>/, e.g. http://packages.python.org/django-authority/. Jannis
On 2009-08-24, Jannis Leidel
A lot less radical and working today:
http://pypi.python.org/pypi/Sphinx-PyPI-upload
which will add an upload_sphinx command to (setuptools based) setup.py, creates a zip file of your Sphinx build directory and uploads it to PyPI to show up at http://packages.python.org/ <package>/, e.g. http://packages.python.org/django-authority/.
Could you add a really quick readme to that package? I'm unsure how to use it and I definitively don't want to experiment with packages.python.org :-) Are there alternatives for uploading documentation there? And is there documentation for the goal of that packages.python.org/* documentation area? Googling on packages.python.org is hard to get useful results out :-) Reinout -- Reinout van Rees - reinout@vanrees.org - http://reinout.vanrees.org Software developer at http://www.thehealthagency.com "Military engineers build missiles. Civil engineers build targets"
On Aug 25, 2009, at 4:44 AM, Reinout van Rees wrote:
On 2009-08-24, Jannis Leidel
wrote: A lot less radical and working today:
http://pypi.python.org/pypi/Sphinx-PyPI-upload
which will add an upload_sphinx command to (setuptools based) setup.py, creates a zip file of your Sphinx build directory and uploads it to PyPI to show up at http://packages.python.org/ <package>/, e.g. http://packages.python.org/django-authority/.
Could you add a really quick readme to that package? I'm unsure how to use it and I definitively don't want to experiment with packages.python.org :-)
I tried playing with this but unfortunately it doesn't seem to work well with a buildout based package. It couldn't find the directory to zip and I wasn't able to use -d to do the right thing.
Are there alternatives for uploading documentation there? And is there documentation for the goal of that packages.python.org/* documentation area? Googling on packages.python.org is hard to get useful results out :-)
It's easy enough to upload documentation manually. Go into the directory that contains your index.html file and do something like 'zip -r docs.zip .' then go to your package's page on pypi and scroll down for the upload form. -Barry
Am 25.08.2009 um 12:02 schrieb Barry Warsaw:
On Aug 25, 2009, at 4:44 AM, Reinout van Rees wrote:
On 2009-08-24, Jannis Leidel
wrote: A lot less radical and working today:
http://pypi.python.org/pypi/Sphinx-PyPI-upload
which will add an upload_sphinx command to (setuptools based) setup.py, creates a zip file of your Sphinx build directory and uploads it to PyPI to show up at http://packages.python.org/ <package>/, e.g. http://packages.python.org/django-authority/.
Could you add a really quick readme to that package? I'm unsure how to use it and I definitively don't want to experiment with packages.python.org :-)
I tried playing with this but unfortunately it doesn't seem to work well with a buildout based package. It couldn't find the directory to zip and I wasn't able to use -d to do the right thing.
Would you mind opening a ticket describing what you did and what not worked? The issue tracker is at http://bitbucket.org/jezdez/sphinx-pypi-upload/ :) Thanks, Jannis
Am 25.08.2009 um 10:44 schrieb Reinout van Rees:
On 2009-08-24, Jannis Leidel
wrote: A lot less radical and working today:
http://pypi.python.org/pypi/Sphinx-PyPI-upload
which will add an upload_sphinx command to (setuptools based) setup.py, creates a zip file of your Sphinx build directory and uploads it to PyPI to show up at http://packages.python.org/ <package>/, e.g. http://packages.python.org/django-authority/.
Could you add a really quick readme to that package? I'm unsure how to use it and I definitively don't want to experiment with packages.python.org :-)
Oh, totally. I added documentation to http://pypi.python.org/pypi/Sphinx-PyPI-upload/ Jannis
participants (5)
-
"Martin v. Löwis"
-
Barry Warsaw
-
Jannis Leidel
-
Reinout van Rees
-
Sridhar Ratnakumar