Re: Documentation patch for pgAdmin 4 - Mailing list pgadmin-hackers

From Susan Douglas
Subject Re: Documentation patch for pgAdmin 4
Date
Msg-id 18CE7CFD-4A3A-4D3A-B415-063DD34BA456@enterprisedb.com
Whole thread Raw
In response to Re: Documentation patch for pgAdmin 4  (Dave Page <dpage@pgadmin.org>)
List pgadmin-hackers
Hi Dave,

I've attached an update that hopefully fixes the problem - I didn't realize that I needed to git add again if I
modifieda file that had already been git added... 



Let me know if there are more/different problems - Thanks!

-- Susan



> On May 26, 2016, at 7:51 AM, Dave Page <dpage@pgadmin.org> wrote:
>
> Hi
>
> On Wed, May 25, 2016 at 3:26 PM, Susan Douglas
> <susan.douglas@enterprisedb.com> wrote:
>> Hi All,
>>
>> I've attached a patch that adds new dialog descriptions to the pgAdmin 4 documentation... Thanks!
>
> I see the following issues when building the docs with this patch. Can
> you please fix and resend?
>
> /Users/dpage/git/pgadmin4/docs/en_US/foreign_server_dialog.rst:60:
> WARNING: image file not readable:
> images/foreign_server_sql_example.png

The name of the graphic is changed in the .rst file - the graphic exists in the images folder, and I've git added the
.rstfile... 

> /Users/dpage/git/pgadmin4/docs/en_US/type_dialog.rst:24: WARNING:
> image file not readable: images/type_definition.png

Renamed and (git) added...

> /Users/dpage/git/pgadmin4/docs/en_US/type_dialog.rst:117: WARNING:
> image file not readable: images/type_sql_example.png

I modified the file to change the name of the png in the .rst file to match the png in the images folder, and git added
itbefore rebuilding... 

> /Users/dpage/git/pgadmin4/docs/en_US/user_mapping_dialog.rst:3:
> SEVERE: Title overline & underline mismatch.
>
> ********************************
> The User Mapping Dialog
> *********************************
>

Fixed... and git added...

> checking consistency...
> /Users/dpage/git/pgadmin4/docs/en_US/materialized_view_dialog.rst::
> WARNING: document isn't included in any toctree
>

Fixed... and git added...

> --
> Dave Page
> Blog: http://pgsnake.blogspot.com
> Twitter: @pgsnake
>
> EnterpriseDB UK: http://www.enterprisedb.com
> The Enterprise PostgreSQL Company


Attachment

pgadmin-hackers by date:

Previous
From: Dave Page
Date:
Subject: pgAdmin 4 commit: Auto-run setup.py if the config database doesn't exis
Next
From: Murtuza Zabuawala
Date:
Subject: PATCH: To fix an issue with port validation (pgAdmin4)