Permalink
Browse files

Added Sphinx boilerplate for documentation

  • Loading branch information...
danielstocks committed Aug 24, 2010
1 parent 9994c74 commit a778ff22ef75788e8a48496ede49f011764d345a
Showing with 757 additions and 146 deletions.
  1. +1 −0 .gitignore
  2. +3 −3 docs/DOM.rst
  3. +130 −0 docs/Makefile
  4. +33 −36 docs/browser-detection.rst
  5. +216 −0 docs/conf.py
  6. +15 −0 docs/contents.rst
  7. +30 −34 docs/events.rst
  8. +43 −0 docs/index.rst
  9. +170 −0 docs/make.bat
  10. +0 −61 docs/options/README.rst
  11. +104 −0 docs/options/index.rst
  12. +12 −12 docs/plugins/flickr.rst
View
@@ -1,2 +1,3 @@
.DS_Store
._*
+_build
View
@@ -1,6 +1,6 @@
-===
-DOM
-===
+=============
+DOM Structure
+=============
Galleria builds a rich DOM structure for each Gallery. You can access them using ``this.get( ID )`` or ``this.$( IDs )``.
Read more about DOM manipulation in the reference API.
View
@@ -0,0 +1,130 @@
+# 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) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+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 " 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/Galleria.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Galleria.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/Galleria"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Galleria"
+ @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."
+
+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."
View
@@ -4,8 +4,8 @@ Broswer detection
These static variables are mainly used to detect browsers.
-Example usage:
-..............
+Example usage
+-------------
::
@@ -14,66 +14,63 @@ Example usage:
Galleria.log('you are using opera!');
}
</script>
-
-List of static variables:
-=========================
-
-Galleria.IE
------------
+
+IE
+---
Detects IE6+ using object detection.
-Galleria.IE6
-------------
+IE6
+----
Detects IE6 using object detection.
-Galleria.IE7
-------------
+IE7
+----
Detects IE7 using object detection.
-Galleria.IE8
-------------
+IE8
+----
Detects IE8 using object detection.
-Galleria.IE9
-------------
+IE9
+----
Detects IE9 using object detection.
-Galleria.WEBKIT
-------------
+WEBKIT
+------
Detects webkit using browser sniffing.
-Galleria.SAFARI
-------------
+SAFARI
+------
Detects safari using browser sniffing.
-Galleria.CHROME
-------------
+CHROME
+------
Detects chrome using browser sniffing.
-Galleria.OPERA
-------------
+OPERA
+-----
Detects opera using object detection.
-Galleria.MAC
-------------
+MAC
+---
Detects macintosh platform using navigator.platform sniffing.
-Galleria.QUIRK
-------------
+QUIRK
+-----
Detects quirkcs mode using object detection.
-Galleria.IPHONE
-------------
+IPHONE
+------
Detects iphone using browser sniffing.
-Galleria.IPAD
-------------
+IPAD
+----
Detects ipad using browser sniffing.
-Galleria.ANDROID
-------------
+ANDROID
+-------
Detects android using browser sniffing.
-Galleria.TOUCH
-------------
+TOUCH
+-----
Detects touch devices using browser sniffing.
Oops, something went wrong.

0 comments on commit a778ff2

Please sign in to comment.