Skip to content
This repository
Browse code

Added Sphinx boilerplate for documentation

  • Loading branch information...
commit a778ff22ef75788e8a48496ede49f011764d345a 1 parent 9994c74
Daniel Stocks authored August 24, 2010
1  .gitignore
... ...
@@ -1,2 +1,3 @@
1 1
 .DS_Store
2 2
 ._*
  3
+_build
6  docs/DOM.rst
Source Rendered
... ...
@@ -1,6 +1,6 @@
1  
-===
2  
-DOM
3  
-===
  1
+=============
  2
+DOM Structure
  3
+=============
4 4
 
5 5
 Galleria builds a rich DOM structure for each Gallery. You can access them using ``this.get( ID )`` or ``this.$( IDs )``. 
6 6
 Read more about DOM manipulation in the reference API.
130  docs/Makefile
... ...
@@ -0,0 +1,130 @@
  1
+# Makefile for Sphinx documentation
  2
+#
  3
+
  4
+# You can set these variables from the command line.
  5
+SPHINXOPTS    =
  6
+SPHINXBUILD   = sphinx-build
  7
+PAPER         =
  8
+BUILDDIR      = _build
  9
+
  10
+# Internal variables.
  11
+PAPEROPT_a4     = -D latex_paper_size=a4
  12
+PAPEROPT_letter = -D latex_paper_size=letter
  13
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  14
+
  15
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
  16
+
  17
+help:
  18
+	@echo "Please use \`make <target>' where <target> is one of"
  19
+	@echo "  html       to make standalone HTML files"
  20
+	@echo "  dirhtml    to make HTML files named index.html in directories"
  21
+	@echo "  singlehtml to make a single large HTML file"
  22
+	@echo "  pickle     to make pickle files"
  23
+	@echo "  json       to make JSON files"
  24
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
  25
+	@echo "  qthelp     to make HTML files and a qthelp project"
  26
+	@echo "  devhelp    to make HTML files and a Devhelp project"
  27
+	@echo "  epub       to make an epub"
  28
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  29
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
  30
+	@echo "  text       to make text files"
  31
+	@echo "  man        to make manual pages"
  32
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
  33
+	@echo "  linkcheck  to check all external links for integrity"
  34
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
  35
+
  36
+clean:
  37
+	-rm -rf $(BUILDDIR)/*
  38
+
  39
+html:
  40
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  41
+	@echo
  42
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  43
+
  44
+dirhtml:
  45
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  46
+	@echo
  47
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  48
+
  49
+singlehtml:
  50
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  51
+	@echo
  52
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  53
+
  54
+pickle:
  55
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  56
+	@echo
  57
+	@echo "Build finished; now you can process the pickle files."
  58
+
  59
+json:
  60
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  61
+	@echo
  62
+	@echo "Build finished; now you can process the JSON files."
  63
+
  64
+htmlhelp:
  65
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  66
+	@echo
  67
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
  68
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
  69
+
  70
+qthelp:
  71
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  72
+	@echo
  73
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
  74
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  75
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Galleria.qhcp"
  76
+	@echo "To view the help file:"
  77
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Galleria.qhc"
  78
+
  79
+devhelp:
  80
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  81
+	@echo
  82
+	@echo "Build finished."
  83
+	@echo "To view the help file:"
  84
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Galleria"
  85
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Galleria"
  86
+	@echo "# devhelp"
  87
+
  88
+epub:
  89
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  90
+	@echo
  91
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  92
+
  93
+latex:
  94
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  95
+	@echo
  96
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  97
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
  98
+	      "(use \`make latexpdf' here to do that automatically)."
  99
+
  100
+latexpdf:
  101
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  102
+	@echo "Running LaTeX files through pdflatex..."
  103
+	make -C $(BUILDDIR)/latex all-pdf
  104
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  105
+
  106
+text:
  107
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  108
+	@echo
  109
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
  110
+
  111
+man:
  112
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  113
+	@echo
  114
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  115
+
  116
+changes:
  117
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  118
+	@echo
  119
+	@echo "The overview file is in $(BUILDDIR)/changes."
  120
+
  121
+linkcheck:
  122
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  123
+	@echo
  124
+	@echo "Link check complete; look for any errors in the above output " \
  125
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
  126
+
  127
+doctest:
  128
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  129
+	@echo "Testing of doctests in the sources finished, look at the " \
  130
+	      "results in $(BUILDDIR)/doctest/output.txt."
69  docs/browser-detection.rst
Source Rendered
@@ -4,8 +4,8 @@ Broswer detection
4 4
 
5 5
 These static variables are mainly used to detect browsers.
6 6
 
7  
-Example usage:
8  
-..............
  7
+Example usage
  8
+-------------
9 9
 
10 10
 ::
11 11
 
@@ -14,66 +14,63 @@ Example usage:
14 14
         Galleria.log('you are using opera!');
15 15
     }
16 16
     </script>
17  
-
18  
-List of static variables:
19  
-=========================
20  
-
21  
-Galleria.IE
22  
------------
  17
+    
  18
+IE
  19
+---
23 20
 Detects IE6+ using object detection.
24 21
 
25  
-Galleria.IE6
26  
-------------
  22
+IE6
  23
+----
27 24
 Detects IE6 using object detection.
28 25
 
29  
-Galleria.IE7
30  
-------------
  26
+IE7
  27
+----
31 28
 Detects IE7 using object detection.
32 29
 
33  
-Galleria.IE8
34  
-------------
  30
+IE8
  31
+----
35 32
 Detects IE8 using object detection.
36 33
 
37  
-Galleria.IE9
38  
-------------
  34
+IE9
  35
+----
39 36
 Detects IE9 using object detection.
40 37
 
41  
-Galleria.WEBKIT
42  
-------------
  38
+WEBKIT
  39
+------
43 40
 Detects webkit using browser sniffing.
44 41
 
45  
-Galleria.SAFARI
46  
-------------
  42
+SAFARI
  43
+------
47 44
 Detects safari using browser sniffing.
48 45
 
49  
-Galleria.CHROME
50  
-------------
  46
+CHROME
  47
+------
51 48
 Detects chrome using browser sniffing.
52 49
 
53  
-Galleria.OPERA
54  
-------------
  50
+OPERA
  51
+-----
55 52
 Detects opera using object detection.
56 53
 
57  
-Galleria.MAC
58  
-------------
  54
+MAC
  55
+---
59 56
 Detects macintosh platform using navigator.platform sniffing.
60 57
 
61  
-Galleria.QUIRK
62  
-------------
  58
+QUIRK
  59
+-----
63 60
 Detects quirkcs mode using object detection.
64 61
 
65  
-Galleria.IPHONE
66  
-------------
  62
+IPHONE
  63
+------
67 64
 Detects iphone using browser sniffing.
68 65
 
69  
-Galleria.IPAD
70  
-------------
  66
+IPAD
  67
+----
71 68
 Detects ipad using browser sniffing.
72 69
 
73  
-Galleria.ANDROID
74  
-------------
  70
+ANDROID
  71
+-------
75 72
 Detects android using browser sniffing.
76 73
 
77  
-Galleria.TOUCH
78  
-------------
  74
+TOUCH
  75
+-----
79 76
 Detects touch devices using browser sniffing.
216  docs/conf.py
... ...
@@ -0,0 +1,216 @@
  1
+# -*- coding: utf-8 -*-
  2
+#
  3
+# Galleria documentation build configuration file, created by
  4
+# sphinx-quickstart on Sun Aug 22 04:00:02 2010.
  5
+#
  6
+# This file is execfile()d with the current directory set to its containing dir.
  7
+#
  8
+# Note that not all possible configuration values are present in this
  9
+# autogenerated file.
  10
+#
  11
+# All configuration values have a default; values that are commented out
  12
+# serve to show the default.
  13
+
  14
+import sys, os
  15
+
  16
+# If extensions (or modules to document with autodoc) are in another directory,
  17
+# add these directories to sys.path here. If the directory is relative to the
  18
+# documentation root, use os.path.abspath to make it absolute, like shown here.
  19
+#sys.path.insert(0, os.path.abspath('.'))
  20
+
  21
+# -- General configuration -----------------------------------------------------
  22
+
  23
+# If your documentation needs a minimal Sphinx version, state it here.
  24
+#needs_sphinx = '1.0'
  25
+
  26
+# Add any Sphinx extension module names here, as strings. They can be extensions
  27
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  28
+extensions = []
  29
+
  30
+# Add any paths that contain templates here, relative to this directory.
  31
+templates_path = ['_templates']
  32
+
  33
+# The suffix of source filenames.
  34
+source_suffix = '.rst'
  35
+
  36
+# The encoding of source files.
  37
+#source_encoding = 'utf-8-sig'
  38
+
  39
+# The master toctree document.
  40
+master_doc = 'index'
  41
+
  42
+# General information about the project.
  43
+project = u'Galleria'
  44
+copyright = u'2010, Aino'
  45
+
  46
+# The version info for the project you're documenting, acts as replacement for
  47
+# |version| and |release|, also used in various other places throughout the
  48
+# built documents.
  49
+#
  50
+# The short X.Y version.
  51
+version = '1.2'
  52
+# The full version, including alpha/beta/rc tags.
  53
+release = '1.2b1'
  54
+
  55
+# The language for content autogenerated by Sphinx. Refer to documentation
  56
+# for a list of supported languages.
  57
+#language = None
  58
+
  59
+# There are two options for replacing |today|: either, you set today to some
  60
+# non-false value, then it is used:
  61
+#today = ''
  62
+# Else, today_fmt is used as the format for a strftime call.
  63
+#today_fmt = '%B %d, %Y'
  64
+
  65
+# List of patterns, relative to source directory, that match files and
  66
+# directories to ignore when looking for source files.
  67
+exclude_patterns = ['_build','._*','**/._*']
  68
+
  69
+# The reST default role (used for this markup: `text`) to use for all documents.
  70
+#default_role = None
  71
+
  72
+# If true, '()' will be appended to :func: etc. cross-reference text.
  73
+#add_function_parentheses = True
  74
+
  75
+# If true, the current module name will be prepended to all description
  76
+# unit titles (such as .. function::).
  77
+#add_module_names = True
  78
+
  79
+# If true, sectionauthor and moduleauthor directives will be shown in the
  80
+# output. They are ignored by default.
  81
+#show_authors = False
  82
+
  83
+# The name of the Pygments (syntax highlighting) style to use.
  84
+pygments_style = 'sphinx'
  85
+
  86
+# A list of ignored prefixes for module index sorting.
  87
+#modindex_common_prefix = []
  88
+
  89
+
  90
+# -- Options for HTML output ---------------------------------------------------
  91
+
  92
+# The theme to use for HTML and HTML Help pages.  See the documentation for
  93
+# a list of builtin themes.
  94
+html_theme = 'default'
  95
+
  96
+# Theme options are theme-specific and customize the look and feel of a theme
  97
+# further.  For a list of options available for each theme, see the
  98
+# documentation.
  99
+#html_theme_options = {}
  100
+
  101
+# Add any paths that contain custom themes here, relative to this directory.
  102
+#html_theme_path = []
  103
+
  104
+# The name for this set of Sphinx documents.  If None, it defaults to
  105
+# "<project> v<release> documentation".
  106
+#html_title = None
  107
+
  108
+# A shorter title for the navigation bar.  Default is the same as html_title.
  109
+#html_short_title = None
  110
+
  111
+# The name of an image file (relative to this directory) to place at the top
  112
+# of the sidebar.
  113
+#html_logo = None
  114
+
  115
+# The name of an image file (within the static path) to use as favicon of the
  116
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  117
+# pixels large.
  118
+#html_favicon = None
  119
+
  120
+# Add any paths that contain custom static files (such as style sheets) here,
  121
+# relative to this directory. They are copied after the builtin static files,
  122
+# so a file named "default.css" will overwrite the builtin "default.css".
  123
+html_static_path = ['_static']
  124
+
  125
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  126
+# using the given strftime format.
  127
+#html_last_updated_fmt = '%b %d, %Y'
  128
+
  129
+# If true, SmartyPants will be used to convert quotes and dashes to
  130
+# typographically correct entities.
  131
+#html_use_smartypants = True
  132
+
  133
+# Custom sidebar templates, maps document names to template names.
  134
+#html_sidebars = {}
  135
+
  136
+# Additional templates that should be rendered to pages, maps page names to
  137
+# template names.
  138
+#html_additional_pages = {}
  139
+
  140
+# If false, no module index is generated.
  141
+#html_domain_indices = True
  142
+
  143
+# If false, no index is generated.
  144
+#html_use_index = True
  145
+
  146
+# If true, the index is split into individual pages for each letter.
  147
+#html_split_index = False
  148
+
  149
+# If true, links to the reST sources are added to the pages.
  150
+#html_show_sourcelink = True
  151
+
  152
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  153
+#html_show_sphinx = True
  154
+
  155
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  156
+#html_show_copyright = True
  157
+
  158
+# If true, an OpenSearch description file will be output, and all pages will
  159
+# contain a <link> tag referring to it.  The value of this option must be the
  160
+# base URL from which the finished HTML is served.
  161
+#html_use_opensearch = ''
  162
+
  163
+# This is the file name suffix for HTML files (e.g. ".xhtml").
  164
+#html_file_suffix = None
  165
+
  166
+# Output file base name for HTML help builder.
  167
+htmlhelp_basename = 'Galleriadoc'
  168
+
  169
+
  170
+# -- Options for LaTeX output --------------------------------------------------
  171
+
  172
+# The paper size ('letter' or 'a4').
  173
+#latex_paper_size = 'letter'
  174
+
  175
+# The font size ('10pt', '11pt' or '12pt').
  176
+#latex_font_size = '10pt'
  177
+
  178
+# Grouping the document tree into LaTeX files. List of tuples
  179
+# (source start file, target name, title, author, documentclass [howto/manual]).
  180
+latex_documents = [
  181
+  ('index', 'Galleria.tex', u'Galleria Documentation',
  182
+   u'Aino', 'manual'),
  183
+]
  184
+
  185
+# The name of an image file (relative to this directory) to place at the top of
  186
+# the title page.
  187
+#latex_logo = None
  188
+
  189
+# For "manual" documents, if this is true, then toplevel headings are parts,
  190
+# not chapters.
  191
+#latex_use_parts = False
  192
+
  193
+# If true, show page references after internal links.
  194
+#latex_show_pagerefs = False
  195
+
  196
+# If true, show URL addresses after external links.
  197
+#latex_show_urls = False
  198
+
  199
+# Additional stuff for the LaTeX preamble.
  200
+#latex_preamble = ''
  201
+
  202
+# Documents to append as an appendix to all manuals.
  203
+#latex_appendices = []
  204
+
  205
+# If false, no module index is generated.
  206
+#latex_domain_indices = True
  207
+
  208
+
  209
+# -- Options for manual page output --------------------------------------------
  210
+
  211
+# One entry per manual page. List of tuples
  212
+# (source start file, name, description, authors, manual section).
  213
+man_pages = [
  214
+    ('index', 'galleria', u'Galleria Documentation',
  215
+     [u'Aino'], 1)
  216
+]
15  docs/contents.rst
Source Rendered
... ...
@@ -0,0 +1,15 @@
  1
+.. _contents:
  2
+
  3
+=================
  4
+Table of Contents
  5
+=================
  6
+
  7
+
  8
+Options
  9
+-------
  10
+
  11
+.. toctree::
  12
+    :glob:
  13
+    :maxdepth: 1
  14
+
  15
+    options/*
64  docs/events.rst
Source Rendered
@@ -17,20 +17,16 @@ Use ``.bind()`` to listen to the Galleria events. In the callback, the this keyw
17 17
         }
18 18
     });
19 19
     
20  
-    
21  
-List of public events
22  
-=====================
23  
-
24  
-Galleria.THUMBNAIL
25  
-------------------
  20
+THUMBNAIL
  21
+---------
26 22
 
27 23
 Triggers when a thumbnail is loaded and displayed in Galleria. Adds the following properties to the event object:
28 24
 
29 25
 - **thumbTarget** (HTML element) The thumbnail IMG element
30 26
 - **thumbOrder** (int) the index of the thumbnail, starting at 0
31 27
 
32  
-Galleria.LOADSTART
33  
-------------------
  28
+LOADSTART
  29
+---------
34 30
 
35 31
 Triggers every time Galleria begins loading an image. Adds the following properties to the event object:
36 32
 
@@ -39,8 +35,8 @@ Triggers every time Galleria begins loading an image. Adds the following propert
39 35
 - **thumbTarget** (HTML element) The ``IMG`` element of the thumbnail that belongs to the imageTarget.
40 36
 - **index** (Number) The galleria index of the image about to load.
41 37
 
42  
-Galleria.LOADFINISH
43  
--------------------
  38
+LOADFINISH
  39
+----------
44 40
 
45 41
 Triggers every time Galleria has finnished loading an image. Adds the following properties to the event object:
46 42
 
@@ -49,8 +45,8 @@ Triggers every time Galleria has finnished loading an image. Adds the following
49 45
 - **thumbTarget** (HTML element) The ``IMG`` element of the thumbnail that belongs to the imageTarget.
50 46
 - **index** (Number) The galleria index of the image loaded.
51 47
 
52  
-Galleria.IMAGE
53  
--------------------
  48
+IMAGE
  49
+-----
54 50
 
55 51
 Triggers when the gallery image is displayed after loading and transition. Adds the following properties to the event object:
56 52
 
@@ -58,18 +54,18 @@ Triggers when the gallery image is displayed after loading and transition. Adds
58 54
 - **thumbTarget** (HTML element) The ``IMG`` element of the active thumbnail.
59 55
 - **index** (Number) The galleria index of the image loaded.
60 56
 
61  
-Galleria.PLAY
62  
--------------------
  57
+PLAY
  58
+----
63 59
 
64 60
 Triggers when the galleria slideshow starts playing.
65 61
 
66  
-Galleria.PAUSE
67  
--------------------
  62
+PAUSE
  63
+-----
68 64
 
69 65
 Triggers when the galleria slideshow stops playing.
70 66
 
71  
-Galleria.PROGRESS
72  
--------------------
  67
+PROGRESS
  68
+--------
73 69
 
74 70
 Triggers every x milliseconds during slideshow. You can listen to this if you want to create a progress bar for slideshows. Adds the following properties to the event object:
75 71
 
@@ -77,43 +73,43 @@ Triggers every x milliseconds during slideshow. You can listen to this if you wa
77 73
 - **seconds** (Number) prints the seconds elapsed since the last image during slideshow.
78 74
 - **milliseconds** (Number) prints the milliseconds elapsed since the last image during slideshow.
79 75
 
80  
-Galleria.FULLSCREEN_ENTER
81  
--------------------
  76
+FULLSCREEN_ENTER
  77
+----------------
82 78
 
83 79
 Triggers when the gallery goes into fullscreen mode.
84 80
 
85  
-Galleria.FULLSCREEN_EXIT
86  
--------------------
  81
+FULLSCREEN_EXIT
  82
+---------------
87 83
 
88 84
 Triggers when the gallery exits the fullscreen mode.
89 85
 
90  
-Galleria.IDLE_ENTER
91  
--------------------
  86
+IDLE_ENTER
  87
+----------
92 88
 
93 89
 Triggers when the gallery goes into idle mode.
94 90
 
95  
-Galleria.IDLE_EXIT
96  
--------------------
  91
+IDLE_EXIT
  92
+---------
97 93
 
98 94
 Triggers when the gallery exists idle mode.
99 95
 
100  
-Galleria.RESCALE
101  
--------------------
  96
+RESCALE
  97
+-------
102 98
 
103 99
 Triggers every time the rescale() method is used and completed for rescaling the gallery.
104 100
 
105  
-Galleria.LIGHTBOX_OPEN
106  
--------------------
  101
+LIGHTBOX_OPEN
  102
+-------------
107 103
 
108 104
 Triggers every time the lightbox is opened.
109 105
 
110  
-Galleria.LIGHTBOX_CLOSE
111  
--------------------
  106
+LIGHTBOX_CLOSE
  107
+--------------
112 108
 
113 109
 Triggers every time the lightbox is closed.
114 110
 
115  
-Galleria.LIGHTBOX_IMAGE
116  
--------------------
  111
+LIGHTBOX_IMAGE
  112
+--------------
117 113
 
118 114
 Triggers when the lightbox image is displayed after loading and transition. Adds the following properties to the event object:
119 115
 
43  docs/index.rst
Source Rendered
... ...
@@ -0,0 +1,43 @@
  1
+.. _index:
  2
+
  3
+======================
  4
+Galleria Documentation
  5
+======================
  6
+
  7
+.. rubric:: Everything you need to know about Galleria (hopefully).
  8
+
  9
+Introduction
  10
+------------
  11
+
  12
+.. toctree::
  13
+    :maxdepth: 1
  14
+    
  15
+    tutorials/getting-started
  16
+    tutorials/extending-galleria
  17
+    DOM
  18
+
  19
+API Layer
  20
+---------
  21
+
  22
+.. toctree::
  23
+    :maxdepth: 1
  24
+    
  25
+    options/index
  26
+    events
  27
+    browser-detection
  28
+
  29
+Plugins
  30
+-------
  31
+
  32
+.. toctree::
  33
+    :maxdepth: 1
  34
+    
  35
+    plugins/flickr
  36
+
  37
+Misc
  38
+----
  39
+
  40
+.. toctree::
  41
+    :maxdepth: 1
  42
+    
  43
+    contents
170  docs/make.bat
... ...
@@ -0,0 +1,170 @@
  1
+@ECHO OFF
  2
+
  3
+REM Command file for Sphinx documentation
  4
+
  5
+if "%SPHINXBUILD%" == "" (
  6
+	set SPHINXBUILD=sphinx-build
  7
+)
  8
+set BUILDDIR=_build
  9
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
  10
+if NOT "%PAPER%" == "" (
  11
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
  12
+)
  13
+
  14
+if "%1" == "" goto help
  15
+
  16
+if "%1" == "help" (
  17
+	:help
  18
+	echo.Please use `make ^<target^>` where ^<target^> is one of
  19
+	echo.  html       to make standalone HTML files
  20
+	echo.  dirhtml    to make HTML files named index.html in directories
  21
+	echo.  singlehtml to make a single large HTML file
  22
+	echo.  pickle     to make pickle files
  23
+	echo.  json       to make JSON files
  24
+	echo.  htmlhelp   to make HTML files and a HTML help project
  25
+	echo.  qthelp     to make HTML files and a qthelp project
  26
+	echo.  devhelp    to make HTML files and a Devhelp project
  27
+	echo.  epub       to make an epub
  28
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  29
+	echo.  text       to make text files
  30
+	echo.  man        to make manual pages
  31
+	echo.  changes    to make an overview over all changed/added/deprecated items
  32
+	echo.  linkcheck  to check all external links for integrity
  33
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
  34
+	goto end
  35
+)
  36
+
  37
+if "%1" == "clean" (
  38
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
  39
+	del /q /s %BUILDDIR%\*
  40
+	goto end
  41
+)
  42
+
  43
+if "%1" == "html" (
  44
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
  45
+	if errorlevel 1 exit /b 1
  46
+	echo.
  47
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
  48
+	goto end
  49
+)
  50
+
  51
+if "%1" == "dirhtml" (
  52
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
  53
+	if errorlevel 1 exit /b 1
  54
+	echo.
  55
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
  56
+	goto end
  57
+)
  58
+
  59
+if "%1" == "singlehtml" (
  60
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
  61
+	if errorlevel 1 exit /b 1
  62
+	echo.
  63
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
  64
+	goto end
  65
+)
  66
+
  67
+if "%1" == "pickle" (
  68
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
  69
+	if errorlevel 1 exit /b 1
  70
+	echo.
  71
+	echo.Build finished; now you can process the pickle files.
  72
+	goto end
  73
+)
  74
+
  75
+if "%1" == "json" (
  76
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
  77
+	if errorlevel 1 exit /b 1
  78
+	echo.
  79
+	echo.Build finished; now you can process the JSON files.
  80
+	goto end
  81
+)
  82
+
  83
+if "%1" == "htmlhelp" (
  84
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
  85
+	if errorlevel 1 exit /b 1
  86
+	echo.
  87
+	echo.Build finished; now you can run HTML Help Workshop with the ^
  88
+.hhp project file in %BUILDDIR%/htmlhelp.
  89
+	goto end
  90
+)
  91
+
  92
+if "%1" == "qthelp" (
  93
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
  94
+	if errorlevel 1 exit /b 1
  95
+	echo.
  96
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
  97
+.qhcp project file in %BUILDDIR%/qthelp, like this:
  98
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Galleria.qhcp
  99
+	echo.To view the help file:
  100
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Galleria.ghc
  101
+	goto end
  102
+)
  103
+
  104
+if "%1" == "devhelp" (
  105
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
  106
+	if errorlevel 1 exit /b 1
  107
+	echo.
  108
+	echo.Build finished.
  109
+	goto end
  110
+)
  111
+
  112
+if "%1" == "epub" (
  113
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
  114
+	if errorlevel 1 exit /b 1
  115
+	echo.
  116
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
  117
+	goto end
  118
+)
  119
+
  120
+if "%1" == "latex" (
  121
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
  122
+	if errorlevel 1 exit /b 1
  123
+	echo.
  124
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
  125
+	goto end
  126
+)
  127
+
  128
+if "%1" == "text" (
  129
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
  130
+	if errorlevel 1 exit /b 1
  131
+	echo.
  132
+	echo.Build finished. The text files are in %BUILDDIR%/text.
  133
+	goto end
  134
+)
  135
+
  136
+if "%1" == "man" (
  137
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
  138
+	if errorlevel 1 exit /b 1
  139
+	echo.
  140
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
  141
+	goto end
  142
+)
  143
+
  144
+if "%1" == "changes" (
  145
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
  146
+	if errorlevel 1 exit /b 1
  147
+	echo.
  148
+	echo.The overview file is in %BUILDDIR%/changes.
  149
+	goto end
  150
+)
  151
+
  152
+if "%1" == "linkcheck" (
  153
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
  154
+	if errorlevel 1 exit /b 1
  155
+	echo.
  156
+	echo.Link check complete; look for any errors in the above output ^
  157
+or in %BUILDDIR%/linkcheck/output.txt.
  158
+	goto end
  159
+)
  160
+
  161
+if "%1" == "doctest" (
  162
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
  163
+	if errorlevel 1 exit /b 1
  164
+	echo.
  165
+	echo.Testing of doctests in the sources finished, look at the ^
  166
+results in %BUILDDIR%/doctest/output.txt.
  167
+	goto end
  168
+)
  169
+
  170
+:end
61  docs/options/README.rst
Source Rendered
... ...
@@ -1,61 +0,0 @@
1  
-================
2  
-Galleria Options
3  
-================
4  
-
5  
-Galleria options are defined using a flat object during initialization.::
6  
-
7  
-    $('#galleria').galleria({
8  
-        preload: 3,
9  
-        transition: 'fade',
10  
-        image_crop: true
11  
-    });
12  
-
13  
-**Note:** You can define your own options and set defaults for each theme using the Theme builder API.
14  
-
15  
-List of options
16  
-...............
17  
-
18  
-- **autoplay** — sets Galleria to play slidehow when initialized
19  
-- **carousel** — toggle the creation of a carousel
20  
-- **carousel_follow** — defines if the carousel should follow the image
21  
-- **carousel_speed** — carousel animation speed in milliseconds
22  
-- **carousel_steps** — defines how many "steps" the carousel should take on each nav click
23  
-- **clicknext** — helper for adding a click event on the entire stage to move forward
24  
-- **data_config** — defines how Galleria should parse the HTML
25  
-- **data_selector** — defines the selector Galleria should look for in the source
26  
-- **data_source** — defines the Galleria data, or the HTML source where the data is found.
27  
-- **debug** — set this to true to get error messages
28  
-- **easing** — defines the easing mode globally
29  
-- **extend** — add custom functionality to the gallery
30  
-- **height** — manually set a gallery height
31  
-- **idle_time** — defines how long delay before Galleria goes into idle mode.
32  
-- **image_crop** — defines how Galleria will crop the image
33  
-- **image_margin** — sets a margin between the image and the stage
34  
-- **image_pan** — toggles the image pan effect
35  
-- **image_pan_smoothness** — defines how smooth ( and CPU consuming ) the pan effect should be.
36  
-- **image_position** — positions the image
37  
-- **keep_source** — lets you keep the source elements
38  
-- **lightbox_fade_speed** — defines how fast the lighbox should fade
39  
-- **lightbox_transition_speed** — defines how fast the lighbox should animate
40  
-- **max_scale_ratio** — defines how much Galleria is allowed to scale
41  
-- **min_scale_ratio** — defines how much Galleria must scale
42  
-- **on_image** — helper event method for adding custom functionality every time an image is shown
43  
-- **overlay_opacity** — sets how transparent the overlay should be
44  
-- **overlay_background** — defines the background color of the overlay
45  
-- **pause_on_interaction** — toggles if Galleria should stop playing if the user navigates
46  
-- **popup_links** — open Image links in new windos
47  
-- **preload** — defines how much Galleria should preload
48  
-- **queue** — defines if Galleria should queue the slideshow
49  
-- **show** — lets you start the slideshow at any image index
50  
-- **show_info** — toggles the caption
51  
-- **show_counter** — toggles the counter
52  
-- **show_imagenav** — toggles the image navigation arrows
53  
-- **thumb_crop** — same as image_crop for thumbnails
54  
-- **thumb_fit** — lets you fit thumbnails according to width
55  
-- **thumb_margin** — same as image_margin for thumbnails
56  
-- **thumb_quality** — Defines if and how IE should use bicubic image rendering for thumbnails
57  
-- **thumbnails** — sets how and if thumbnails should be created
58  
-- **transition** — defines what transition to use
59  
-- **transition_initial** — sets a different transition on the the first image
60  
-- **transition_speed** — defines the speed of the transition
61  
-- **width** — manually set a gallery width
104  docs/options/index.rst
Source Rendered
... ...
@@ -0,0 +1,104 @@
  1
+=======
  2
+Options
  3
+=======
  4
+
  5
+Galleria options are defined using a flat object during initialization.::
  6
+
  7
+    $('#galleria').galleria({
  8
+        preload: 3,
  9
+        transition: 'fade',
  10
+        image_crop: true
  11
+    });
  12
+
  13
+**Note:** You can define your own options and set defaults for each theme using the Theme builder API.
  14
+
  15
+List of options
  16
+***************
  17
+
  18
+:doc:`autoplay` Sets Galleria to play slidehow when initialized.
  19
+
  20
+:doc:`carousel` Toggle the creation of a carousel.
  21
+
  22
+:doc:`carousel_follow` Defines if the carousel should follow the image.
  23
+
  24
+:doc:`carousel_speed` Carousel animation speed in milliseconds.
  25
+
  26
+:doc:`carousel_steps` Defines how many "steps" the carousel should take on each nav click.
  27
+
  28
+:doc:`clicknext` Helper for adding a click event on the entire stage to move forward.
  29
+
  30
+:doc:`data_config` Defines how Galleria should parse the HTML.
  31
+
  32
+:doc:`data_selector` Defines the selector Galleria should look for in the source.
  33
+
  34
+:doc:`data_source` Defines the Galleria data, or the HTML source where the data is found.
  35
+
  36
+:doc:`debug` Set this to true to get error messages.
  37
+
  38
+:doc:`easing` Defines the easing mode globally.
  39
+
  40
+:doc:`extend` Add custom functionality to the gallery.
  41
+
  42
+:doc:`height` Manually set a gallery height.
  43
+
  44
+:doc:`idle_time` Defines how long delay before Galleria goes into idle mode.
  45
+
  46
+:doc:`image_crop` Defines how Galleria will crop the image.
  47
+
  48
+:doc:`image_margin` Sets a margin between the image and the stage.
  49
+
  50
+:doc:`image_pan` Toggles the image pan effect.
  51
+
  52
+:doc:`image_pan_smoothness` Defines how smooth ( and CPU consuming ) the pan effect should be.
  53
+
  54
+:doc:`image_position` Positions the image.
  55
+
  56
+:doc:`keep_source` Lets you keep the source elements.
  57
+
  58
+:doc:`lightbox_fade_speed` Defines how fast the lightbox should fade.
  59
+
  60
+:doc:`lightbox_transition_speed` Defines how fast the lightbox should animate.
  61
+
  62
+:doc:`max_scale_ratio` Defines how much Galleria is allowed to scale.
  63
+
  64
+:doc:`min_scale_ratio` Defines how much Galleria must scale.
  65
+
  66
+:doc:`on_image` Helper event method for adding custom functionality every time an image is shown.
  67
+
  68
+:doc:`overlay_opacity` Sets how transparent the overlay should be.
  69
+
  70
+:doc:`overlay_background` Defines the background color of the overlay.
  71
+
  72
+:doc:`pause_on_interaction` Toggles if Galleria should stop playing if the user navigates.
  73
+
  74
+:doc:`popup_links` Open Image links in new windows.
  75
+
  76
+:doc:`preload` Defines how much Galleria should preload.
  77
+
  78
+:doc:`queue` Defines if Galleria should queue the slideshow.
  79
+
  80
+:doc:`show` Lets you start the slideshow at any image index.
  81
+
  82
+:doc:`show_info` Toggles the caption.
  83
+
  84
+:doc:`show_counter` Toggles the counter.
  85
+
  86
+:doc:`show_imagenav` Toggles the image navigation arrows.
  87
+
  88
+:doc:`thumb_crop` Same as image_crop for thumbnails.
  89
+
  90
+:doc:`thumb_fit` Lets you fit thumbnails according to width.
  91
+
  92
+:doc:`thumb_margin` Same as image_margin for thumbnails.
  93
+
  94
+:doc:`thumb_quality` Defines if and how IE should use bicubic image rendering for thumbnails
  95
+
  96
+:doc:`thumbnails` Sets how and if thumbnails should be created.
  97
+
  98
+:doc:`transition` Defines what transition to use.
  99
+
  100
+:doc:`transition_initial` Sets a different transition on the the first image.
  101
+
  102
+:doc:`transition_speed` Defines the speed of the transition.
  103
+
  104
+:doc:`width` Manually set a gallery width.
24  docs/plugins/flickr.rst
Source Rendered
... ...
@@ -1,6 +1,6 @@
1  
-======
  1
+=============
2 2
 Flickr Plugin
3  
-======
  3
+=============
4 4
 
5 5
 Galleria comes with a flickr plugin that can be used to fetch images from flickr and display them in your Galleria gallery.
6 6
 
@@ -45,7 +45,7 @@ Reference API
45 45
 Modifies the default options for ``Galleria.Flickr``. **options** is an Object with your custom options that will override the defaults.
46 46
 
47 47
 .search(search_string, options, callback)
48  
-----------------------
  48
+-----------------------------------------
49 49
 
50 50
     | returns **Galleria.Flickr**
51 51
 
@@ -56,7 +56,7 @@ A helper function for searching Flickr and converting the data to a Galleria-fri
56 56
 - **callback(data)** (Function) gets called when the data is ready. The first argument is the Galleria-friendly image data object.
57 57
 
58 58
 .getTags(tags, [options,] callback)
59  
-----------------------
  59
+-----------------------------------
60 60
 
61 61
     | returns **Galleria.Flickr**
62 62
 
@@ -67,7 +67,7 @@ A helper function for searching Flickr for tags and converting the data to a Gal
67 67
 - **callback(data)** (Function) gets called when the data is ready. The first argument is the Galleria-friendly image data object.
68 68
 
69 69
 .getUser(username, [options,] callback)
70  
-----------------------
  70
+---------------------------------------
71 71
 
72 72
     | returns **Galleria.Flickr**
73 73
 
@@ -78,7 +78,7 @@ Get all pictures from a user's photostream. The username is the same name as in
78 78
 - **callback(data)** (Function) gets called when the data is ready. The first argument is the Galleria-friendly image data object.
79 79
 
80 80
 .getSet(set_id, [options,] callback)
81  
-----------------------
  81
+------------------------------------
82 82
 
83 83
     | returns **Galleria.Flickr**
84 84
 
@@ -89,7 +89,7 @@ Get all pictures from a specific photoset.
89 89
 - **callback(data)** (Function) gets called when the data is ready. The first argument is the Galleria-friendly image data object.
90 90
 
91 91
 .searchGroup(search_string, callback)
92  
-----------------------
  92
+-------------------------------------
93 93
 
94 94
     | returns **Galleria.Flickr**
95 95
 
@@ -109,7 +109,7 @@ example::
109 109
 - **callback(groups)** (Function) gets called when the search is complete. The first argument is the array of matches.
110 110
 
111 111
 .getGroup(nsid, [options,] callback)
112  
-----------------------
  112
+------------------------------------
113 113
 
114 114
     | returns **Galleria.Flickr**
115 115
 
@@ -120,7 +120,7 @@ Get all pictures from a specific group/pool.
120 120
 - **callback(data)** (Function) gets called when the data is ready. The first argument is the Galleria-friendly image data object.
121 121
 
122 122
 .getGallery(gallery_id, [options,] callback)
123  
-----------------------
  123
+--------------------------------------------
124 124
 
125 125
     | returns **Galleria.Flickr**
126 126
 
@@ -143,7 +143,7 @@ max
143 143
 Sets the amount of images that will be fetched (max 100)
144 144
 
145 145
 size
146  
-------------
  146
+----
147 147
 
148 148
     | type: **String**
149 149
     | default: **'medium'**
@@ -151,7 +151,7 @@ size
151 151
 This options defines what size the plugin will fetch from flickr. Possible values are 'small', 'medium','big' and 'original'. Note that the 'big' size (1024px wide) is only available if the original size exceeds 1280px wide. If not, 'big' will return the biggest size available. 'original' will always return the biggest image available, but this can slow down performance significantly.
152 152
 
153 153
 sort
154  
-------------
  154
+----
155 155
 
156 156
     | type: **String**
157 157
     | default: **'interestingness-desc'**
@@ -159,7 +159,7 @@ sort
159 159
 How to sort the images. Available options are: date-posted-asc, date-posted-desc, date-taken-asc, date-taken-desc, interestingness-desc, interestingness-asc, and relevance.
160 160
 
161 161
 description
162  
-------------
  162
+-----------
163 163
 
164 164
     | type: **Boolean**
165 165
     | default: **false**

0 notes on commit a778ff2

Please sign in to comment.
Something went wrong with that request. Please try again.