Skip site navigation (1) Skip section navigation (2)

Re: Fixed warnings for Docs project

From: Akshay Joshi <akshay(dot)joshi(at)enterprisedb(dot)com>
To: Dave Page <dpage(at)pgadmin(dot)org>
Cc: pgadmin-hackers <pgadmin-hackers(at)postgresql(dot)org>
Subject: Re: Fixed warnings for Docs project
Date: 2012-05-10 09:22:57
Message-ID: CANxoLDdtxXozBzQGaNGRFwQS0g1fuKxZduBGh2eWS7W+Ts-AbQ@mail.gmail.com (view raw or flat)
Thread:
Lists: pgadmin-hackers
On Wed, May 9, 2012 at 8:07 PM, Dave Page <dpage(at)pgadmin(dot)org> wrote:

> Thanks.
>
> I think we need to do some fine tuning here. There are a few issues:
>
> - It looks like "search" is a reserved name. Sphinx creates a search
> page in the HTML format docs with that name, so clicking on the link
> to see how to search in pgAdmin takes you to the search form (does
> that even work?). I guess the search.rst page needs renaming.
>

  Renamed to search_object.rst.

>
> - The Appendices page needn't list the licences twice - it looks weird
> in HTML, and far more bizarre in PDF format, where the pages in the
> TOC get included inline.
>

  Fixed.

>
> - The MIT Kerberos Licence section shouldn't have "Kerberos Copyright"
> as a sub-section on the Appendices page. That should only be a title
> (maybe make it lower-level?) on the licence page itself.
>

  Fixed. By adding :titlesonly: flag in TOC. Attached is the patch file.

>
> - In PDF format, I see "Contents:" scattered around the doc. I assume
> that's where there's a TOC, and the sub-page has been included inline
> instead of the list of sub pages titles. It shouldn't be there - not
> sure though if that's an issue with the way the TOCs have been
> included in the ReST files, or a Sphinx issue.
>

  Currently working on it.

>
> Thanks.
>
> On Wed, May 9, 2012 at 2:01 PM, Akshay Joshi
> <akshay(dot)joshi(at)enterprisedb(dot)com> wrote:
> > Modified search.png file attached.
> >
> >
> > On Wed, May 9, 2012 at 6:26 PM, Akshay Joshi <
> akshay(dot)joshi(at)enterprisedb(dot)com>
> > wrote:
> >>
> >> Wrong png file attached as I did git reset HEAD --hard. Wait will send
> new
> >> image.
> >>
> >>
> >> On Wed, May 9, 2012 at 6:24 PM, Akshay Joshi
> >> <akshay(dot)joshi(at)enterprisedb(dot)com> wrote:
> >>>
> >>> Sorry, Attached.
> >>>
> >>>
> >>> On Wed, May 9, 2012 at 5:35 PM, Dave Page <dpage(at)pgadmin(dot)org> wrote:
> >>>>
> >>>> EATTACHMENTMISSING :-)
> >>>>
> >>>> On Wed, May 9, 2012 at 1:00 PM, Akshay Joshi
> >>>> <akshay(dot)joshi(at)enterprisedb(dot)com> wrote:
> >>>> > Hi Dave
> >>>> >
> >>>> > I did following changes in Docs project
> >>>> >
> >>>> > Removed warnings during compilation of Docs project.
> >>>> > Added missing default-xsl.rst and sample-xml.rst file.
> >>>> > Added TOC tree.
> >>>> > Modified search.png file. Attached with the mail.
> >>>> >
> >>>> > Attached is the patch file, please review it and if it looks OK to
> you
> >>>> > then
> >>>> > please commit it.
> >>>> >
> >>>> > --
> >>>> > Akshay Joshi
> >>>> > Senior Software Engineer
> >>>> > EnterpriseDB Corporation
> >>>> > The Enterprise PostgreSQL Company
> >>>> > Phone: +91 20-3058-9522
> >>>> > Mobile: +91 976-788-8246
> >>>> >
> >>>>
> >>>>
> >>>>
> >>>> --
> >>>> Dave Page
> >>>> Blog: http://pgsnake.blogspot.com
> >>>> Twitter: @pgsnake
> >>>>
> >>>> EnterpriseDB UK: http://www.enterprisedb.com
> >>>> The Enterprise PostgreSQL Company
> >>>
> >>>
> >>>
> >>>
> >>> --
> >>> Akshay Joshi
> >>> Senior Software Engineer
> >>> EnterpriseDB Corporation
> >>> The Enterprise PostgreSQL Company
> >>> Phone: +91 20-3058-9522
> >>> Mobile: +91 976-788-8246
> >>>
> >>
> >>
> >>
> >> --
> >> Akshay Joshi
> >> Senior Software Engineer
> >> EnterpriseDB Corporation
> >> The Enterprise PostgreSQL Company
> >> Phone: +91 20-3058-9522
> >> Mobile: +91 976-788-8246
> >>
> >
> >
> >
> > --
> > Akshay Joshi
> > Senior Software Engineer
> > EnterpriseDB Corporation
> > The Enterprise PostgreSQL Company
> > Phone: +91 20-3058-9522
> > Mobile: +91 976-788-8246
> >
>
>
>
> --
> Dave Page
> Blog: http://pgsnake.blogspot.com
> Twitter: @pgsnake
>
> EnterpriseDB UK: http://www.enterprisedb.com
> The Enterprise PostgreSQL Company
>



-- 
*Akshay Joshi
Senior Software Engineer
EnterpriseDB Corporation
The Enterprise PostgreSQL Company
Phone: +91 20-3058-9522
Mobile: +91 976-788-8246*

Attachment: Fixed_Docs.patch
Description: application/octet-stream (13.8 KB)

In response to

Responses

pgadmin-hackers by date

Next:From: Dave PageDate: 2012-05-10 11:00:06
Subject: pgAdmin III commit: Fix various doc formating issues related to theTOC
Previous:From: Dave PageDate: 2012-05-10 09:22:05
Subject: Bundling 1.16-beta1

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group