Support to Read The Docs

Author: wind39

.gitignore

@@ -1,2 +1,3 @@
 *.directory
+.DS_Store
 

requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+recommonmark

rtfd/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

rtfd/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

rtfd/source/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'OmniDB'
+copyright = 'The OmniDB Team'
+author = 'The OmniDB Team'
+
+# The full version, including alpha/beta/rc tags
+release = '2.15.0'
+
+# Path to the initial page
+master_doc = 'index'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['recommonmark']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

rtfd/source/en

@@ -0,0 +1 @@
+../../src/en/

rtfd/source/index.rst

@@ -0,0 +1,36 @@
+The OmniDB Handbook
+===================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   en/01_introduction.md
+   en/02_installation.md
+   en/03_creating_users_and_connections.md
+   en/04_managing_databases.md
+   en/05_creating_changing_and_removing_tables.md
+   en/06_managing_table_data.md
+   en/07_writing_sql_queries.md
+   en/08_visualizing_query_plans.md
+   en/09_visualizing_data.md
+   en/10_managing_other_elements.md
+   en/11_additional_features.md
+   en/12_omnidb_config_tool.md
+   en/13_writing_and_debugging_plpgsql_functions.md
+   en/14_monitoring_dashboard.md
+   en/15_logical_replication.md
+   en/16_pglogical.md
+   en/17_postgres-bdr.md
+   en/18_postgres-xl.md
+   en/19_deploying_omnidb-server.md
+   en/20_console_tab.md
+   en/21_plugin_system.md
+   en/22_advanced_object_search.md
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

src/en/01_introduction.md

@@ -4,7 +4,7 @@ author: [William Ivanski, Rafael Thofehrn Castro, Israel Barth Rubio]
 date: "2ndQuadrant"
 ...
 
-# Introduction
+# 1. Introduction
 
 **OmniDB** is an open source browser-based app designed to access and manage
 many different Database Management systems, e.g. PostgreSQL, Oracle and MySQL.

src/en/02_installation.md

@@ -1,4 +1,4 @@
-# Installation
+# 2. Installation
 
 OmniDB provides 2 kinds of packages to fit every user needs:
 

src/en/03_creating_users_and_connections.md

@@ -1,4 +1,4 @@
-# Creating Users and Connections
+# 3. Creating Users and Connections
 
 #### Logging in as user *admin*
 

src/en/04_managing_databases.md

@@ -1,4 +1,4 @@
-# Managing Databases
+# 4. Managing Databases
 
 After creating a connection you can select it by clicking in the *Select
 Connection* action in the connections grid. You will see that the connection

src/en/05_creating_changing_and_removing_tables.md

@@ -1,4 +1,4 @@
-# Creating, Changing and Removing Tables
+# 5. Creating, Changing and Removing Tables
 
 #### Creating tables
 

src/en/06_managing_table_data.md

@@ -1,4 +1,4 @@
-# Managing Table Data
+# 6. Managing Table Data
 
 The tool allows us to edit records contained in tables through a very simple and
 intuitive interface. Given that only a few DBMS have unique identifiers for

src/en/07_writing_sql_queries.md

@@ -1,4 +1,4 @@
-# Writing SQL Queries
+# 7. Writing SQL Queries
 
 The most common kind of inner tab is the *Query Tab*, containing the following
 elements:

src/en/08_visualizing_query_plans.md

@@ -1,4 +1,4 @@
-# Visualizing Query Plans
+# 8. Visualizing Query Plans
 
 OmniDB 2.2.0 introduced a very useful feature: graphical query plan
 visualization. This may come in handy when writing or optimizing queries, since

src/en/09_visualizing_data.md

@@ -1,4 +1,4 @@
-# Visualizing Data
+# 9. Visualizing Data
 
 This feature displays a graph with nodes representing tables and edges
 representing table relationships with foreign keys. Using the mouse, the user is

src/en/10_managing_other_elements.md

@@ -1,4 +1,4 @@
-# Managing other Elements
+# 10. Managing other Elements
 
 All PostgreSQL structures are possible to be managed with the use of
 *SQL templates*. This gives the user more power than using graphical forms to

src/en/11_additional_features.md

@@ -1,4 +1,4 @@
-# Additional Features
+# 11. Additional Features
 
 #### User Settings
 

src/en/12_omnidb_config_tool.md

@@ -1,4 +1,4 @@
-# OmniDB Config Tool
+# 12. OmniDB Config Tool
 
 Every installation of OmniDB also comes with a small CLI utility called *OmniDB
 Config*. It will have a different file name, depending on the way you installed

src/en/13_writing_and_debugging_plpgsql_functions.md

@@ -1,4 +1,4 @@
-# Writing and Debugging PL/pgSQL Functions
+# 13. Writing and Debugging PL/pgSQL Functions
 
 #### Introduction
 

src/en/14_monitoring_dashboard.md

@@ -1,4 +1,4 @@
-# Monitoring Dashboard
+# 14. Monitoring Dashboard
 
 OmniDB 2.4.0 introduced a new cool feature called *Monitoring Dashboard*. We
 know a picture is worth a thousand words, so please take a look:

src/en/15_logical_replication.md

@@ -1,4 +1,4 @@
-# Logical Replication
+# 15. Logical Replication
 
 PostgreSQL 10 introduces native logical replication, which uses a
 publish/subscribe model and so we can create publications on the upstream (or

src/en/16_pglogical.md

@@ -1,4 +1,4 @@
-# pglogical
+# 16. pglogical
 
 [pglogical](https://www.2ndquadrant.com/en/resources/pglogical/) is a PostgreSQL
 extension that provides an advanced logical replication system that serves as a

src/en/17_postgres-bdr.md

@@ -1,4 +1,4 @@
-# Postgres-BDR
+# 17. Postgres-BDR
 
 [Postgres-BDR](https://www.2ndquadrant.com/en/resources/bdr/) (or just **BDR**,
 for short) is an open source project from 2ndQuadrant that provides multi-master

src/en/18_postgres-xl.md

@@ -1,4 +1,4 @@
-# Postgres-XL
+# 18. Postgres-XL
 
 [Postgres-XL](https://www.2ndquadrant.com/en/resources/postgres-xl/) (or just
 **XL**, for short) is an open source project from 2ndQuadrant. It is a massively

src/en/19_deploying_omnidb-server.md

@@ -1,4 +1,4 @@
-# Deploying omnidb-server
+# 19. Deploying omnidb-server
 
 Whenever deploying omnidb-server the user must be aware of how OmniDB works in
 terms of ports so the environment can be properly configured taking the

src/en/20_console_tab.md

@@ -1,4 +1,4 @@
-# Console Tab
+# 20. Console Tab
 
 Introduced in OmniDB 2.6.0, the new OmniDB Console Tab provides an easy and
 confortable way to interact with your databases. Users familiar with the `psql`

src/en/21_plugin_system.md

@@ -1,4 +1,4 @@
-# Plugin System
+# 21. Plugin System
 
 OmniDB 2.9 introduces the plugin system, a feature that allows users to develop and
 share their own features that can be plugged into OmniDB without having to deploy

src/en/22_advanced_object_search.md

@@ -1,4 +1,4 @@
-# Advanced Object Search
+# 22. Advanced Object Search
 
 OmniDB 2.9 introduces the a Advanced Object Search feature, allowing users to
 use an advanced pattern matching to search database objects and tables data. The