Re: overhauling the manual (was pyblosxom 1.4 status)

"John Gabriele" <[email protected]>
Newsgroups gmane.comp.web.pyblosxom.devel
Message-ID <[email protected]>
On 5/22/07, Will Guaraldi <[email protected]> wrote:
> On 5/22/07, Will Guaraldi <[email protected]> wrote:
> >
> > I'll take chapter 4.
>
> Wow--took about 20 minutes and then another 5 to fiddle with some things.

Sweet.

> Given that we don't have to "compile" reST documents and that they can
> be read in "source-form", I'm going to create a new "docs/" directory
> and put the reST versions of documents.
>
> I'm converting <literal> ... </literal>, <varname> ... </varname>, and
> <filename> ... </filename> all to `` ... ``.

I did the same for <command> as well.

> Everything else is
> pretty straightforward: lists -> lists, bulleted lists -> bulleted
> lists, programlistings -> :: blocks, ...

Yup.

> I'm also adding to the top of the file:
>
> ::
>
>    :Author: PyBlosxom Development Team
>    :Version: $Id$
>    :Copyright: This document has been placed in the public domain.
>
>    .. contents::
>
>
> Any thoughts on that?

Sounds great.

Couple issues:

1. I don't yet know how to tell reST I want all the separate docs
stitched together.

2. Not sure how to make internal links to a location in another
chapter if that chapter resides in a separate file. Will have to
fiddle with this, but it's late and I'm going to bed. :)

See attached for the first 3 chapters.

---John

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/

_______________________________________________
Pyblosxom-devel mailing list
Pyblosxom-devel-5NWGOfrQmneRv+LV9MX5uipxlwaOVQ5f@public.gmane.org
https://lists.sourceforge.net/lists/listinfo/pyblosxom-devel
rst_docs.tar.bz2 (application/x-bzip2, 6.1 KB) - not displayed
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.