Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
tev
plugin_event
Commits
694de59f
Commit
694de59f
authored
Feb 12, 2015
by
LE GAC Renaud
Browse files
Partial user guide using sphinx.
parent
3dc34697
Changes
9
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
742 additions
and
0 deletions
+742
-0
.gitignore
.gitignore
+1
-0
static/docs/userguide/Makefile
static/docs/userguide/Makefile
+153
-0
static/docs/userguide/source/appendixa.rst
static/docs/userguide/source/appendixa.rst
+131
-0
static/docs/userguide/source/appendixb.rst
static/docs/userguide/source/appendixb.rst
+43
-0
static/docs/userguide/source/appendixc.rst
static/docs/userguide/source/appendixc.rst
+124
-0
static/docs/userguide/source/conf.py
static/docs/userguide/source/conf.py
+242
-0
static/docs/userguide/source/dbfields.rst
static/docs/userguide/source/dbfields.rst
+18
-0
static/docs/userguide/source/index.rst
static/docs/userguide/source/index.rst
+26
-0
static/docs/userguide/source/list.rst
static/docs/userguide/source/list.rst
+4
-0
No files found.
.gitignore
View file @
694de59f
...
...
@@ -8,6 +8,7 @@ cache/
cron/
databases
databases*/
*build*
*jsduck*
*epydoc*
errors/
...
...
static/docs/userguide/Makefile
0 → 100644
View file @
694de59f
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS
=
SPHINXBUILD
=
sphinx-build
PAPER
=
BUILDDIR
=
build
# Internal variables.
PAPEROPT_a4
=
-D
latex_paper_size
=
a4
PAPEROPT_letter
=
-D
latex_paper_size
=
letter
ALLSPHINXOPTS
=
-d
$(BUILDDIR)
/doctrees
$
(
PAPEROPT_
$(PAPER)
)
$(SPHINXOPTS)
source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS
=
$
(
PAPEROPT_
$(PAPER)
)
$(SPHINXOPTS)
source
.PHONY
:
help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help
:
@
echo
"Please use
\`
make <target>' where <target> is one of"
@
echo
" html to make standalone HTML files"
@
echo
" dirhtml to make HTML files named index.html in directories"
@
echo
" singlehtml to make a single large HTML file"
@
echo
" pickle to make pickle files"
@
echo
" json to make JSON files"
@
echo
" htmlhelp to make HTML files and a HTML help project"
@
echo
" qthelp to make HTML files and a qthelp project"
@
echo
" devhelp to make HTML files and a Devhelp project"
@
echo
" epub to make an epub"
@
echo
" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@
echo
" latexpdf to make LaTeX files and run them through pdflatex"
@
echo
" text to make text files"
@
echo
" man to make manual pages"
@
echo
" texinfo to make Texinfo files"
@
echo
" info to make Texinfo files and run them through makeinfo"
@
echo
" gettext to make PO message catalogs"
@
echo
" changes to make an overview of all changed/added/deprecated items"
@
echo
" linkcheck to check all external links for integrity"
@
echo
" doctest to run all doctests embedded in the documentation (if enabled)"
clean
:
-
rm
-rf
$(BUILDDIR)
/
*
html
:
$(SPHINXBUILD)
-b
html
$(ALLSPHINXOPTS)
$(BUILDDIR)
/html
@
echo
@
echo
"Build finished. The HTML pages are in
$(BUILDDIR)
/html."
dirhtml
:
$(SPHINXBUILD)
-b
dirhtml
$(ALLSPHINXOPTS)
$(BUILDDIR)
/dirhtml
@
echo
@
echo
"Build finished. The HTML pages are in
$(BUILDDIR)
/dirhtml."
singlehtml
:
$(SPHINXBUILD)
-b
singlehtml
$(ALLSPHINXOPTS)
$(BUILDDIR)
/singlehtml
@
echo
@
echo
"Build finished. The HTML page is in
$(BUILDDIR)
/singlehtml."
pickle
:
$(SPHINXBUILD)
-b
pickle
$(ALLSPHINXOPTS)
$(BUILDDIR)
/pickle
@
echo
@
echo
"Build finished; now you can process the pickle files."
json
:
$(SPHINXBUILD)
-b
json
$(ALLSPHINXOPTS)
$(BUILDDIR)
/json
@
echo
@
echo
"Build finished; now you can process the JSON files."
htmlhelp
:
$(SPHINXBUILD)
-b
htmlhelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
/htmlhelp
@
echo
@
echo
"Build finished; now you can run HTML Help Workshop with the"
\
".hhp project file in
$(BUILDDIR)
/htmlhelp."
qthelp
:
$(SPHINXBUILD)
-b
qthelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
/qthelp
@
echo
@
echo
"Build finished; now you can run "
qcollectiongenerator
" with the"
\
".qhcp project file in
$(BUILDDIR)
/qthelp, like this:"
@
echo
"# qcollectiongenerator
$(BUILDDIR)
/qthelp/track_events.qhcp"
@
echo
"To view the help file:"
@
echo
"# assistant -collectionFile
$(BUILDDIR)
/qthelp/track_events.qhc"
devhelp
:
$(SPHINXBUILD)
-b
devhelp
$(ALLSPHINXOPTS)
$(BUILDDIR)
/devhelp
@
echo
@
echo
"Build finished."
@
echo
"To view the help file:"
@
echo
"# mkdir -p
$$
HOME/.local/share/devhelp/track_events"
@
echo
"# ln -s
$(BUILDDIR)
/devhelp
$$
HOME/.local/share/devhelp/track_events"
@
echo
"# devhelp"
epub
:
$(SPHINXBUILD)
-b
epub
$(ALLSPHINXOPTS)
$(BUILDDIR)
/epub
@
echo
@
echo
"Build finished. The epub file is in
$(BUILDDIR)
/epub."
latex
:
$(SPHINXBUILD)
-b
latex
$(ALLSPHINXOPTS)
$(BUILDDIR)
/latex
@
echo
@
echo
"Build finished; the LaTeX files are in
$(BUILDDIR)
/latex."
@
echo
"Run
\`
make' in that directory to run these through (pdf)latex"
\
"(use
\`
make latexpdf' here to do that automatically)."
latexpdf
:
$(SPHINXBUILD)
-b
latex
$(ALLSPHINXOPTS)
$(BUILDDIR)
/latex
@
echo
"Running LaTeX files through pdflatex..."
$(MAKE)
-C
$(BUILDDIR)
/latex all-pdf
@
echo
"pdflatex finished; the PDF files are in
$(BUILDDIR)
/latex."
text
:
$(SPHINXBUILD)
-b
text
$(ALLSPHINXOPTS)
$(BUILDDIR)
/text
@
echo
@
echo
"Build finished. The text files are in
$(BUILDDIR)
/text."
man
:
$(SPHINXBUILD)
-b
man
$(ALLSPHINXOPTS)
$(BUILDDIR)
/man
@
echo
@
echo
"Build finished. The manual pages are in
$(BUILDDIR)
/man."
texinfo
:
$(SPHINXBUILD)
-b
texinfo
$(ALLSPHINXOPTS)
$(BUILDDIR)
/texinfo
@
echo
@
echo
"Build finished. The Texinfo files are in
$(BUILDDIR)
/texinfo."
@
echo
"Run
\`
make' in that directory to run these through makeinfo"
\
"(use
\`
make info' here to do that automatically)."
info
:
$(SPHINXBUILD)
-b
texinfo
$(ALLSPHINXOPTS)
$(BUILDDIR)
/texinfo
@
echo
"Running Texinfo files through makeinfo..."
make
-C
$(BUILDDIR)
/texinfo info
@
echo
"makeinfo finished; the Info files are in
$(BUILDDIR)
/texinfo."
gettext
:
$(SPHINXBUILD)
-b
gettext
$(I18NSPHINXOPTS)
$(BUILDDIR)
/locale
@
echo
@
echo
"Build finished. The message catalogs are in
$(BUILDDIR)
/locale."
changes
:
$(SPHINXBUILD)
-b
changes
$(ALLSPHINXOPTS)
$(BUILDDIR)
/changes
@
echo
@
echo
"The overview file is in
$(BUILDDIR)
/changes."
linkcheck
:
$(SPHINXBUILD)
-b
linkcheck
$(ALLSPHINXOPTS)
$(BUILDDIR)
/linkcheck
@
echo
@
echo
"Link check complete; look for any errors in the above output "
\
"or in
$(BUILDDIR)
/linkcheck/output.txt."
doctest
:
$(SPHINXBUILD)
-b
doctest
$(ALLSPHINXOPTS)
$(BUILDDIR)
/doctest
@
echo
"Testing of doctests in the sources finished, look at the "
\
"results in
$(BUILDDIR)
/doctest/output.txt."
static/docs/userguide/source/appendixa.rst
0 → 100644
View file @
694de59f
.. _Appendix A:
Appendix A: List of database fields
===================================
Events
------
.. list-table::
* -
-
* - ``events.id``
- integer
* - ``events.event``
- string
* - ``events.definition``
- string
* - ``events.data``
- dictionary
Fundings
--------
.. list-table::
* -
-
* - ``fundings.id``
- integer
* - ``fundings.agency``
- string
* - ``funding.definition``
- string
History
-------
.. list-table::
* -
-
* - ``history.id``
- integer
* - ``history.id_people``
- integer
* - ``history.id_teams``
- integer
* - ``history.id_projects``
- integer
* - ``history.id_people_categories``
- integer
* - ``history.id_fundings``
- integer
* - ``history.id_events``
- integer
* - ``history.start_date``
- date
* - ``history.end_date``
- date
* - ``history.percentage``
- integer
* - ``history.note``
- string
* - ``history.data``
- dictionary
People
------
.. list-table::
* -
-
* - ``people.id``
- integer
* - ``people.first_name``
- string
* - ``people.last_name``
- string
* - ``people.initials``
- string
* - ``people.birth_date``
- date
* - ``people.note``
- string
People categories
-----------------
.. list-table::
* -
-
* - ``people_categories.id``
- integer
* - ``people_categories.code``
- string
* - ``people_categories.category``
- string
* - ``people_categories.definition``
- string
Projects
--------
.. list-table::
* -
-
* - ``projects.id``
- integer
* - ``projects.project``
- string
* - ``projects.agencies``
- string
Teams
-----
.. list-table::
* -
-
* - ``teams.id``
- integer
* - ``teams.team``
- string
* - ``teams.domain``
- string
static/docs/userguide/source/appendixb.rst
0 → 100644
View file @
694de59f
.. _Appendix B:
Appendix B: List of virtual fields
=======================================
History
-------
.. list-table::
* -
-
* - ``history.coverage``
- float
* - ``history.duration``
- float
* - ``history.fte``
- float
* - ``history.is_over``
- boolean
People
------
.. list-table::
* -
-
* - ``people.age``
- float
Time axis
---------
The time is not a database table, but the ``year`` can be used as a database
field.
.. list-table::
* -
-
* - ``year``
- integer
static/docs/userguide/source/appendixc.rst
0 → 100644
View file @
694de59f
.. _Appendix C:
Appendix C: Column configuration
===================================
List
----
The configuration parameter for the List column are those of the
``Ext.grid.column.Column`` class. The most important one are listed in the next
sections. Those marked with a (*) are mandatory.
all columns
^^^^^^^^^^^
.. list-table::
:widths: 15 10 70
* -
-
-
* - ``align``
-
- Possible values are: ``left``, ``center``, and ``right``.
* - ``columnWidth``
-
- can be specified as a number or a percentage.
* - ``dbField``
- (*)
- Address of the database field.
* - ``hidden``
-
- ``True`` to hide the column.
* - ``renderer``
-
- javascript function to render the value.
* - ``text``
- (*)
- The label of the column.
* - ``xtype``
- (*)
- specified the type of the column.
The mapping between the type of the column and the one of the database field is
the following:
.. list-table::
* - ``booleancolumn``
- boolean
* - ``datecolumn``
- date or datetime
* - ``numbercolumn``
- integer or float
* - ``gridcolumn``
- string
booleancolumn
^^^^^^^^^^^^^
.. list-table::
:widths: 15 70
* -
-
* - ``falseText``
- the string return in the grid when the value is False.
* - ``trueText``
- the string return in the grid when the value is True.
datecolumn
^^^^^^^^^^
.. list-table::
:widths: 15 70
* -
-
* - ``format``
- format string, e.g. ``d/m/Y``.
numbercolumn
^^^^^^^^^^^^
.. list-table::
:widths: 15 70
* -
-
* - ``format``
- format string, e.g. ``0,000.00``.
Metric 1D
---------
The configuration parameters for the Metric1D column is similar to
those of the ``numbercolumn`` since the table only contains number. Therefore
it is not required to specify the column type.
.. list-table::
:widths: 15 10 70
* -
-
-
* - ``aggregate``
- (*)
- name of the aggregation function, e.g. count, sum, mean,...
* - ``align``
-
- Possible values are: ``left``, ``center``, and ``right``.
* - ``columnWidth``
-
- can be specified as a number or a percentage.
* - ``dbField``
- (*)
- Address of the database field.
* - ``hidden``
-
- ``True`` to hide the column.
* - ``renderer``
-
- javascript function to render the value.
* - ``text``
- (*)
- The label of the column.
static/docs/userguide/source/conf.py
0 → 100644
View file @
694de59f
# -*- coding: utf-8 -*-
#
# track_events documentation build configuration file, created by
# sphinx-quickstart on Thu Feb 12 18:25:36 2015.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import
sys
,
os
# 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('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions
=
[
'sphinx.ext.todo'
]
# Add any paths that contain templates here, relative to this directory.
templates_path
=
[
'_templates'
]
# The suffix of source filenames.
source_suffix
=
'.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc
=
'index'
# General information about the project.
project
=
u
'track_events'
copyright
=
u
'2015, R. Le Gac'
# 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 short X.Y version.
version
=
'0.3'
# The full version, including alpha/beta/rc tags.
release
=
'0.3.0-86'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns
=
[]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style
=
'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- 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
=
'sphinxdoc'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# 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'
]
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename
=
'track_eventsdoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements
=
{