Skip to content

GitLab

Docker-in-Docker (DinD) capabilities of public runners deactivated. More info

Commit 29e3fca3 authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Restore docs/plugin_dbui/api/

parent 93aaa20b
Hide whitespace changes
Inline Side-by-side
Showing with 76 additions and 103 deletions
docs/plugin_dbui/api/conf.py
View file @ 29e3fca3
# -*- coding: utf-8 -*-
#
# plugin_dbui documentation build configuration file, created by
# sphinx-quickstart on Sat Apr 11 11:17:03 2015.
......@@ -16,28 +15,26 @@ import re
import sys
from datetime import datetime
from pathlib import Path
def get_plugin_dbui_release():
JSBASE = "../../static/plugin_dbui/src/Dbui.js"
s = open(JSBASE, "rb").read()
m = re.match('(.+ version: ")([\w._-]*)(".+)', s, re.DOTALL)
return m.group(2)
def get_version():
return Path("../../../VERSION").read_text()
# 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.
# sys.path.insert(0, os.path.abspath("."))
sys.path.insert(0, os.path.abspath("../../modules"))
sys.path.insert(0, os.path.abspath("../../../modules"))
# docker image
# web2py module from the my docker image running sphinx-build
if os.path.exists("/opt/web2py"):
sys.path.insert(0, os.path.abspath("/opt/web2py"))
# older running environment
else:
sys.path.insert(0, os.path.abspath("../../../web2py"))
print("error: missing source code for web2py!!!")
sys.exit(1)
# -- General configuration -----------------------------------------------------
......@@ -55,10 +52,10 @@ extensions = ["sphinx.ext.autodoc",
"sphinx.ext.viewcode"]
# autosummary configuration
autosummary_generate = False
autosummary_generate = True
# intersphinx configuration
intersphinx_mapping = {"python": ("http://docs.python.org/2.7", None)}
intersphinx_mapping = {"python": ("http://docs.python.org/3.7", None)}
# napoleon configuration
napoleon_user_rtype = False
......@@ -77,15 +74,15 @@ master_doc = "index"
# General information about the project.
now = datetime.now()
project = u"plugin_dbui"
copyright = u"2009-%s, R. Le Gac, licensed under CeCILL" % now.year
project = "plugin_dbui"
copyright = "2009-%s, R. Le Gac, licensed under CeCILL" % now.year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The full version, including alpha/beta/rc tags.
release = get_plugin_dbui_release()
release = get_version()
# The short X.Y version.
version = release[:release.rfind(".")]
......@@ -221,8 +218,8 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
("index", "plugin_dbui.tex", u"plugin\\_dbui Documentation",
u"R. Le Gac", "manual"),
("index", "plugin_dbui.tex", r"plugin\_dbui Documentation",
"R. Le Gac", "manual"),
]
# The name of an image file (relative to this directory) to place at the top of
......@@ -251,8 +248,8 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
("index", "plugin_dbui", u"plugin_dbui Documentation",
[u"R. Le Gac"], 1)
("index", "plugin_dbui", "plugin_dbui Documentation",
["R. Le Gac"], 1)
]
# If true, show URL addresses after external links.
......@@ -265,8 +262,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
("index", "plugin_dbui", u"plugin_dbui Documentation",
u"R. Le Gac", "plugin_dbui", "One line description of project.",
("index", "plugin_dbui", "plugin_dbui Documentation",
"R. Le Gac", "plugin_dbui", "One line description of project.",
"Miscellaneous"),
]
......
docs/plugin_dbui/api/database_model.rst
View file @ 29e3fca3
......@@ -32,13 +32,3 @@ Filters
CLEAN_COMMA
CLEAN_SPACES
Validators
^^^^^^^^^^
.. currentmodule:: plugin_dbui.validator
.. autosummary::
:toctree: generated/
IS_IN_USET
docs/plugin_dbui/api/extjs_links.txt
View file @ 29e3fca3
......@@ -2,13 +2,13 @@
Links to the Ext JS classes
.. _ExtJS: http://docs-origin.sencha.com/extjs/4.2.1/#!/api
.. _ExtJS: https://docs.sencha.com/extjs/6.2.0/classic
.. _Ext.data.ArrayStore:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.data.ArrayStore
https://docs.sencha.com/extjs/6.2.0/classic/Ext.data.ArrayStore.html
.. _Ext.form.field.Checkbox:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.field.Checkbox
https://docs.sencha.com/extjs/6.2.0/classic/Ext.form.field.Checkbox.html
.. _Dbui.form.field.CombBox:
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.form.field.CombBox
......@@ -17,16 +17,16 @@
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.data.DirectStore
.. _Ext.form.field.Field:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.field.Field
https://docs.sencha.com/extjs/6.2.0/classic/Ext.form.field.Field.html
.. _Dbui.form.field.AceEditor:
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.form.field.AceEditor
.. _Ext.form.FieldContainer:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.FieldContainer
https://docs.sencha.com/extjs/6.2.0/classic/Ext.form.FieldContainer.html
.. _Ext.form.field.Date:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.field.Date
https://docs.sencha.com/extjs/6.2.0/classic/Ext.form.field.Date.html
.. _Dbui.form.field.Dict:
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.form.field.Dict
......@@ -35,28 +35,28 @@
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.form.field.List
.. _Ext.form.field.Number:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.field.Number
https://docs.sencha.com/extjs/6.2.0/classic/Ext.form.field.Number.html
.. _Ext.form.FieldSet:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.FieldSet
https://docs.sencha.com/extjs/6.2.0/classic/Ext.form.FieldSet.html
.. _Ext.form.field.Text:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.field.Text
https://docs.sencha.com/extjs/6.2.0/classic/Ext.form.field.Text.html
.. _Ext.form.field.TextArea:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.field.TextArea
https://docs.sencha.com/extjs/6.2.0/classic/Ext.form.field.TextArea.html
.. _Ext.form.field.Time:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.form.field.Time
https://docs.sencha.com/extjs/6.2.0/classic/Ext.form.field.Time.html
.. _Dbui.form.Panel:
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.form.Panel
.. _Ext.grid.Column:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.grid.Column
https://docs.sencha.com/extjs/6.2.0/classic/Ext.grid.Column.html
.. _Ext.grid.ColumnModel:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.grid.ColumnModel
https://docs.sencha.com/extjs/6.2.0/classic/Ext.grid.ColumnModel.html
.. _Dbui.grid.Filter:
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.grid.Filter
......@@ -65,43 +65,43 @@
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.grid.Panel
.. _Ext.grid.Panel:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.grid.Panel
https://docs.sencha.com/extjs/6.2.0/classic/Ext.grid.Panel.html
.. _Ext.grid.column.RowNumberer:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.grid.column.RowNumberer
https://docs.sencha.com/extjs/6.2.0/classic/Ext.grid.column.RowNumberer
.. _Ext.grid.TemplateColumn:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.grid.TemplateColumn
https://docs.sencha.com/extjs/6.2.0/classic/Ext.grid.TemplateColumn
.. _Dbui.panel.GridWithFilter:
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.panel.GridWithFilter
.. _Ext.data.JsonStore:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.data.JsonStore
https://docs.sencha.com/extjs/6.2.0/classic/Ext.data.JsonStore.html
.. _Ext.data.Model:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.data.Model
https://docs.sencha.com/extjs/6.2.0/classic/Ext.data.Model.html
.. _Ext.toolbar.Paging:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.toolbar.Paging
https://docs.sencha.com/extjs/6.2.0/classic/Ext.toolbar.Paging
.. _Ext.panel.Panel:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.panel.Panel
https://docs.sencha.com/extjs/6.2.0/classic/Ext.panel.Panel.html
.. _Dbui.panel.WithUrlSelector:
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.panel.WithUrlSelector
.. _Ext.data.Store:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.data.Store
https://docs.sencha.com/extjs/6.2.0/classic/Ext.data.Store.html
.. _Ext.tab.Panel:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.tab.Panel
https://docs.sencha.com/extjs/6.2.0/classic/Ext.tab.Panel.html
.. _Dbui.container.Viewport:
https://marprod.in2p3.fr/plugin_dbui_book/static/plugin_dbui/docs/jsduck/index.html#!/api/Dbui.container.Viewport
.. _Ext.Window:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.Window
https://docs.sencha.com/extjs/6.2.0/classic/Ext.Window.html
.. _Ext.data.XmlStore:
http://docs-origin.sencha.com/extjs/4.2.1/#!/api/Ext.data.XmlStore
https://docs.sencha.com/extjs/6.2.0/classic/Ext.data.XmlStore.html
docs/plugin_dbui/api/generated/plugin_dbui.validator.IS_IN_USET.rst deleted 100644 → 0
View file @ 93aaa20b
plugin_dbui.validator.IS_IN_USET
================================
.. currentmodule:: plugin_dbui.validator
.. autoclass:: IS_IN_USET
:show-inheritance:
.. rubric:: Methods
modules/plugin_dbui/dbsvc.py
View file @ 29e3fca3
......@@ -546,7 +546,7 @@ class DbSvc(BaseSvc):
* The keyword ``records`` is a list of dictionary containing
all key value pairs for the record found in the database.
.. include:: ../../../../docs/api/extjs_links.txt
.. include:: ../../../../plugin_dbui/api/extjs_links.txt
"""
self.dbg("Start DbSvc.read")
......
modules/plugin_dbui/extjs.py
View file @ 29e3fca3
......@@ -76,7 +76,7 @@ class Base(Storage):
class ArrayStore(Base):
"""Configurator for the `Ext.data.ArrayStore`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "arraystore"
......@@ -85,7 +85,7 @@ class ArrayStore(Base):
class CheckBox(Base):
"""Configurator for `Ext.form.field.Checkbox`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "checkbox"
......@@ -94,7 +94,7 @@ class CheckBox(Base):
class ComboBox(Base):
"""Configurator for `Dbui.form.field.CombBox`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xcombobox"
......@@ -103,7 +103,7 @@ class ComboBox(Base):
class DirectStore(Base):
"""Configurator for `Dbui.data.DirectStore`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xdirectstore"
......@@ -112,7 +112,7 @@ class DirectStore(Base):
class Field(Base):
"""Configurator for `Ext.form.field.Field`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "field"
......@@ -121,7 +121,7 @@ class Field(Base):
class FieldAceEditor(Base):
"""Configurator for `Dbui.form.field.AceEditor`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xaceeditorfield"
......@@ -130,7 +130,7 @@ class FieldAceEditor(Base):
class FieldContainer(Base):
"""Configurator for `Ext.form.FieldContainer`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "fieldcontainer"
......@@ -139,7 +139,7 @@ class FieldContainer(Base):
class FieldDate(Base):
"""Configurator for `Ext.form.field.Date`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "datefield"
......@@ -148,7 +148,7 @@ class FieldDate(Base):
class FieldDict(Base):
"""Configurator for `Dbui.form.field.Dict`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xdictfield"
......@@ -157,7 +157,7 @@ class FieldDict(Base):
class FieldList(Base):
"""Configurator for `Dbui.form.field.List`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xlistfield"
......@@ -166,7 +166,7 @@ class FieldList(Base):
class FieldNumber(Base):
"""Configurator for `Ext.form.field.Number`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "numberfield"
......@@ -175,7 +175,7 @@ class FieldNumber(Base):
class FieldSet(Base):
"""Configurator for `Ext.form.FieldSet`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "fieldset"
......@@ -187,7 +187,7 @@ class FieldText(Base):
Note:
Regular expression for the validation can be written as a string.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "textfield"
......@@ -203,7 +203,7 @@ class FieldTextArea(Base):
Note:
Regular expression for the validation can be written as a string.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "textarea"
......@@ -216,7 +216,7 @@ class FieldTextArea(Base):
class FieldTime(Base):
"""Configurator for `Ext.form.field.Time`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "timefield"
......@@ -225,7 +225,7 @@ class FieldTime(Base):
class FormPanel(Base):
"""Configurator for `Dbui.form.Panel`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xform"
......@@ -234,7 +234,7 @@ class FormPanel(Base):
class GridColumn(dict):
"""Configurator for `Ext.grid.Column`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
......@@ -245,7 +245,7 @@ class GridColumnModel(list):
Note:
It is implemented as a ``list`` of :class:`.GridColumn`.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
......@@ -253,7 +253,7 @@ class GridColumnModel(list):
class GridFilter(Base):
"""Configurator for `Dbui.grid.Filter`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xgridfilter"
......@@ -262,7 +262,7 @@ class GridFilter(Base):
class GridPanel(Base):
"""Configurator for `Dbui.grid.Panel`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xgrid"
......@@ -271,7 +271,7 @@ class GridPanel(Base):
class GridRowNumberer(Base):
"""Configurator for `Ext.grid.column.RowNumberer`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "rownumberer"
......@@ -280,7 +280,7 @@ class GridRowNumberer(Base):
class GridTemplateColumn(Base):
"""Configurator for `Ext.grid.TemplateColumn`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "templatecolumn"
......@@ -289,7 +289,7 @@ class GridTemplateColumn(Base):
class GridWithFilter(Base):
"""Configurator for `Dbui.panel.GridWithFilter`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xgridwithfilter"
......@@ -298,7 +298,7 @@ class GridWithFilter(Base):
class JsonStore(Base):
"""Configurator for `Ext.data.JsonStore`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "jsonstore"
......@@ -307,7 +307,7 @@ class JsonStore(Base):
class Model(dict):
"""Configurator for `Ext.data.Model`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
......@@ -319,7 +319,7 @@ class Model(dict):
class Panel(Base):
"""Configurator for `Ext.panel.Panel`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "panel"
......@@ -328,7 +328,7 @@ class Panel(Base):
class PanelWithUrlSelector(Base):
"""Configurator for `Dbui.panel.WithUrlSelector`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xpanelwithurlselector"
......@@ -337,7 +337,7 @@ class PanelWithUrlSelector(Base):
class Store(Base):
"""Configurator for `Ext.data.Store`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "store"
......@@ -346,7 +346,7 @@ class Store(Base):
class TabPanel(Base):
"""Configurator for `Ext.tab.Panel`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "tabpanel"
......@@ -355,7 +355,7 @@ class TabPanel(Base):
class Viewport(Base):
"""Configurator for `Dbui.container.Viewport`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xviewport"
......@@ -364,7 +364,7 @@ class Viewport(Base):
class Window(Base):
"""Configurator for `Ext.Window`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "window"
......@@ -373,7 +373,7 @@ class Window(Base):
class XmlStore(Base):
"""Configurator for `Ext.data.XmlStore`_.
.. include:: ../../../docs/api/extjs_links.txt
.. include:: ../../../plugin_dbui/api/extjs_links.txt
"""
xtype = "xmlstore"
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment