[Grok-doc] Please help migrating existing tutorials and howtos to the Sphinx project

Uli Fouquet uli at gnufix.de
Mon Nov 15 05:57:11 EST 2010


Hi there,

Tim Cook wrote:
> On Sun, 2010-11-14 at 18:19 +0100, Sebastian Ware wrote:
> > I am migrating one or two howto/tutrial every day. At that rate I think it will be another two weeks at least until we have moved all the content. 
> > 
> > Please, help with the migration :) the stuff I have moved can be found in the project directories
> > 
> >   sources/tutorials
> >   sources/data_access
> >   sources/view_generation
> > 
> > folders
> 
> I just did the
> sources/tutorials/permissions_tutorial/granting_permissions.rst 

Great, thanks a lot!

> It looks okay after another make html run.  Is it really as simple as
> removing a few formatting marks?

As long as the grok.zope.org source is ReStructuredText it should be
fairly simple. Documents that were put on grok.zope.org with the inline
HTML editor will be more troublesome to convert.

Just out of curiosity: what formatting marks did you remove? We might be
able to support add support for them then.

> Of course I can't push it without permissions.

I think you first have to create a (free) account on bitbucket.org
(unless you have one already) and then tell Sebastian your bitbucket
username. I'm sure he'll be glad to grant you permissions.

> > 1 Install Sphinx
> > 
> >   http://sphinx.pocoo.org/
> 
> Not sure you need to do this.  The buildout got Sphinx and
> dependencies. 

That's right and I'd even recommend to skip step one and use the locally
built Sphinx scripts (in the local bin/ directory) only. This way you
can be sure to use the same Sphinx/Jinja/whatever version as other
documenters.

Best regards,

-- 
Uli

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Dies ist ein digital signierter Nachrichtenteil
Url : http://mail.zope.org/pipermail/grok-doc/attachments/20101115/03ebeee3/attachment.bin 


More information about the grok-doc mailing list