Обсуждение: Fixed warnings for Docs project

EATTACHMENTMISSING :-)

On Wed, May 9, 2012 at 1:00 PM, Akshay Joshi
<akshay.joshi@enterprisedb.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

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.

- 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.

- 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.

- 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.

Thanks.

On Wed, May 9, 2012 at 2:01 PM, Akshay Joshi
<akshay.joshi@enterprisedb.com> wrote:
> Modified search.png file attached.
>
>
> On Wed, May 9, 2012 at 6:26 PM, Akshay Joshi <akshay.joshi@enterprisedb.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.joshi@enterprisedb.com> wrote:
>>>
>>> Sorry, Attached.
>>>
>>>
>>> On Wed, May 9, 2012 at 5:35 PM, Dave Page <dpage@pgadmin.org> wrote:
>>>>
>>>> EATTACHMENTMISSING :-)
>>>>
>>>> On Wed, May 9, 2012 at 1:00 PM, Akshay Joshi
>>>> <akshay.joshi@enterprisedb.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

Thanks Akshay - patch applied.

On Thu, May 10, 2012 at 10:22 AM, Akshay Joshi
<akshay.joshi@enterprisedb.com> wrote:
>
>
> On Wed, May 9, 2012 at 8:07 PM, Dave Page <dpage@pgadmin.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.joshi@enterprisedb.com> wrote:
>> > Modified search.png file attached.
>> >
>> >
>> > On Wed, May 9, 2012 at 6:26 PM, Akshay Joshi
>> > <akshay.joshi@enterprisedb.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.joshi@enterprisedb.com> wrote:
>> >>>
>> >>> Sorry, Attached.
>> >>>
>> >>>
>> >>> On Wed, May 9, 2012 at 5:35 PM, Dave Page <dpage@pgadmin.org> wrote:
>> >>>>
>> >>>> EATTACHMENTMISSING :-)
>> >>>>
>> >>>> On Wed, May 9, 2012 at 1:00 PM, Akshay Joshi
>> >>>> <akshay.joshi@enterprisedb.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
>



--
Dave Page
Blog: http://pgsnake.blogspot.com
Twitter: @pgsnake

EnterpriseDB UK: http://www.enterprisedb.com
The Enterprise PostgreSQL Company