Re: Patch for pgAdmin 4 docs - Mailing list pgadmin-hackers

Hi,

Something is horribly wrong here :-(. I get the following output when
building with this patch, and then the attached index page! Did you
forget to add some new files?

(pgadmin4)piranha:en_US dpage$ make -f Makefile.sphinx html
Generating code-snippet.rst for some of the important classes...
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.4.3
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 67 source files that are out of date
updating environment: 67 added, 0 changed, 0 removed
reading sources... [100%] view_dialog
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'getting_started'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'client_features'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'connecting'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'managing_cluster_objects'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document
u'managing_database_objects'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'modifying_tables'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'management_basics'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'backup_and_restore'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'developer_tools'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'deployment'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'contributions'
/Users/dpage/git/pgadmin4/docs/en_US/index.rst:13: WARNING: toctree
contains reference to nonexisting document u'license'
looking for now-outdated files... none found
pickling environment... done
checking consistency...
/Users/dpage/git/pgadmin4/docs/en_US/add_restore_point_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/backup_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/backup_globals_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/backup_server_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/browser.rst:: WARNING: document
isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/cast_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/change_password_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/check_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/code_overview.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/code_review.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/code_snippets.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/coding_standards.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/collation_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/column_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/connect_error.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/connect_to_server.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/database_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/debugger.rst:: WARNING: document
isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/desktop_deployment.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/domain_constraint_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/domain_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/event_trigger_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/exclusion_constraint_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/extension_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/foreign_data_wrapper_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/foreign_key_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/foreign_server_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/foreign_table_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/fts_configuration_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/fts_dictionary_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/fts_parser_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/fts_template_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/function_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/grant_wizard.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/import_export_data.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/index_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/maintenance_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/materialized_view_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/move_objects.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/pgadmin_login.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/pgadmin_menu_bar.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/pgadmin_tabbed_browser.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/pgadmin_tree_control.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/pgadmin_user.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/preferences.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/primary_key_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/procedure_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/query_tool.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/resource_group_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/restore_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/role_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/rule_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/schema_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/sequence_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/server_deployment.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/server_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/server_group_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/submitting_patches.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/table_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/tablespace_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/translations.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/trigger_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/type_dialog.rst:: WARNING:
document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/unique_constraint_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/user_mapping_dialog.rst::
WARNING: document isn't included in any toctree
/Users/dpage/git/pgadmin4/docs/en_US/view_dialog.rst:: WARNING:
document isn't included in any toctree
done
preparing documents... done
writing output... [100%] view_dialog
/Users/dpage/git/pgadmin4/docs/en_US/submitting_patches.rst:31:
WARNING: unknown document: mailto:pgadmin-hackers@postgresql.org
generating indices... genindex
writing additional pages... search
copying images... [100%] images/foreign_key_action.png
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 79 warnings.

Build finished. The HTML pages are in _build/html.

On Mon, Jun 20, 2016 at 3:58 PM, Susan Douglas
<susan.douglas@enterprisedb.com> wrote:
> Hi All,
>
> At this point I have not made any major changes to the way the TOC/indexes are set up.
>
> There were a lot of inconsistencies in the .rst files (bad links, incomplete names, extra line spacing, etc.)  Some
causedWarnings when I generated the html, and some did not.  In either case, as I updated the files to remove an
inconsistency,the problems with expanded sidebar seemed to correct themselves. 
>
> As a rule, I don't like it when seemingly unrelated changes seem to fix a problem (I'd much rather know why something
makesa difference), but it's working properly locally now (with a shorter, neat sidebar that only expands the current
nodeindex), and if I roll back the changes, there are still problems within the files that ultimately need correcting. 
>
> Thanks!
>
> -- Susan
>



--
Dave Page
VP, Chief Architect, Tools & Installers
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

Blog: http://pgsnake.blogspot.com
Twitter: @pgsnake