Re: Documentation for ZopeSkel Efforts
Israel Saeta Pérez <[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.documentation |
|---|---|
| Message-ID | <[email protected]> |
Hey Alex, On 07/05/2010 02:46 AM, Alex Clark wrote: > Hi, > > > On 7/4/10 7:02 AM, in article [email protected], "Israel Saeta > Pérez"<[email protected]> wrote: > >> On 06/28/2010 09:19 PM, Elizabeth Leddy wrote: >>> Hi all - >>> >>> I want to add some official documentation for zopeskel - where is the >>> best place to do that? I know collective docs is the new hotness but I'm >>> not sure who/what/how on updating that. The zopeskel stuff has several >>> contributors so letting everyone have access would be ideal. >> >> Hey Elizabeth, >> >> sorry for so late reply - my university network filters the NNTP port. :( >> >> Being ZopeSkel a separated well-delimited package, I'd put its >> documentation either inside the proper package README.txt file, >> http://svn.plone.org/svn/collective/ZopeSkel/trunk/README.txt > > Or? Sorry. I was going to write "or any other txt file inside the package", but I wasn't sure if it was going to be shown in the pipy page, and the README.txt file is still short enough, so I skipped that. >> >> >> This would make the documentation available directly in the PyPI page. > > You can also host documentation on PyPI by uploading a zip file that has a > top level index.html (e.g. Sphinx docs), but I have a feeling eleddy is > looking for a more "central" place to host the ZopeSkel docsŠ More central for the documentation of a package than the package itself? One cool thing would be to be able to generate pretty, browseable documentation pages from the packages' README files, a là http://packages.python.org/z3c.form/ > In fact, this reminds me of one of my yet-to-be-proposed-proposals I am > considering for 4.1: Include ZopeSkel in Plone core. But doesn't ZopeSkel include other templates not related to Plone (e.g. Silva, nested_namespace, recipe)? -- israel ------------------------------------------------------------------------------ This SF.net email is sponsored by Sprint What will you do first with EVO, the first 4G phone? Visit sprint.com/first -- http://p.sf.net/sfu/sprint-com-first