From 8a50f8735151f93c758f0475d886f3066aadb013 Mon Sep 17 00:00:00 2001 From: Simon Date: Fri, 9 Nov 2012 00:42:16 +0100 Subject: [PATCH] Move documentation to sphinx --- README.rst | 116 ++--------------- docs/Makefile | 153 ++++++++++++++++++++++ docs/_static/logo.png | Bin 0 -> 4527 bytes docs/conf.py | 289 ++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 147 +++++++++++++++++++++ docs/make.bat | 190 +++++++++++++++++++++++++++ 6 files changed, 793 insertions(+), 102 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/_static/logo.png create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/README.rst b/README.rst index e98c7ad..b06404c 100644 --- a/README.rst +++ b/README.rst @@ -1,109 +1,21 @@ -===================================================== - sigal - yet another simple static gallery generator -===================================================== +sigal - yet another simple static gallery generator +=================================================== -sigal is yet another python script to build a static gallery of images: +Sigal is yet another simple static gallery generator. It's written in Python +and it allows to build a static gallery of images with the following features: * process directories recursively, * resize images and create thumbnails, -* generate html pages using jinja2 templates and with relative links for a - portable output. +* generate html pages using jinja2 templates, +* relative links for a portable output, +* MIT licensed. -Dependencies ------------- +Links -- Python Imaging Library (PIL / Pillow) -- Jinja2 -- Python Markdown -- pyexiv2 (optionnal, used to copy exif metadatas) +* Latest documentation on `readthedocs.org`_ +* Source, issues and pull requests on `Github`_ +* Releases on `PyPI`_ -Usage ------ - -:: - - $ sigal [-h] [--version] [-f] input_dir output_dir - -Required arguments: - -================ ===================== - ``input_dir`` input directory - ``output_dir`` output directory -================ ===================== - -Optional arguments: - -=================== ============================================== - ``-h|--help`` Show this help message and exit - ``--version`` Show program's version number and exit - ``-f|--force`` Force the reprocessing of existing images and thumbnails - ``-v, --verbose`` Show all messages. - ``-d, --debug`` Show all message, including debug messages. -=================== ============================================== - -Settings --------- - -The configuration for the gallery must be set in ``/sigal.conf``. - -:: - - [sigal] - - # theme - theme = default - - # size of resized image - img_size = 640x480 - - # generate thumbnails - make_thumbs = 1 - - # directory of the thumbnails - thumb_dir = thumbnail - - # prefix for thumbnails name - thumb_prefix = tn- - - # thumbnail size - thumb_size = 200x150 - - # crop the image to fill the box - thumb_fit = 1 - - # keep big image - big_img = 1 - bigimg_dir = original - - # jpeg quality - jpg_quality = 90 - - # keep exif metadatas in output image - exif = 1 - - # add a copyright text on the image - copyright = An example copyright message - - -Album information ------------------ - -Information on an album can be given in a file using the markdown syntax, -named `index.mkd` :: - - Title: Another example gallery - Representative: test2.jpg - - And a *cool* description. - -If this file does not exist the directory's name is used for the title, and -the first image of the directory is used as representative. - -Credits -------- - -sigal use or is inspired from some code from other projects: - -* galleria: http://galleria.aino.se/ -* WordPress Photography Theme: http://thethemefoundry.com/photography/ -* lazygal: http://sousmonlit.dyndns.org/~niol/playa/oss/projects/lazygal/ +.. _readthedocs.org: http://sigal.rtfd.org/ +.. _Github: https://github.com/saimn/sigal/ +.. _PyPI: http://pypi.python.org/pypi/sigal diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..2b37f0d --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,153 @@ +# 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) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.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 ' where 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/Sigal.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Sigal.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/Sigal" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Sigal" + @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." diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..212017aa763f0b778ed2318ed1435d742353449e GIT binary patch literal 4527 zcmZWtXEa>h*B`w{kCue!(Ff5J!Waxj5WNLaqIX7*5=6@+YP5(TB1#AbDY`@-o#-Ma z7(^R2-t&CNA{$g6yI@Q@-vM_-d-j)szr75WINf`vdB zRditY9)!%|ZBX}3Cb%!}hU`wWC26*)v7j|!TCx>9-K7k@U1V0ZH^=%AF2cs@)^Jg+ zUaa1jjv(Ejn2wOeTTMk*4y>oGqyUBYo4J<-i z%4ft?_86Z(pY9^xRwuXDYdg2b}b1}`oioi10f(NDEQ{fmpjCemgZ)AKR@aB4@5eUOleT#5&+bUEM#cqhW8)chyaSG*skAiS?=9G}lXzuuF;O|P05Jo#{uSuB+LQW8 zGOoUUKRV#}e!OXAHxB3eB{Cp5c>Tg;OMYb|Kq;IsAAIQLFqE(O4(qCL8zz$Zrl_c> zaDY|R)W?)@Zf?#sN%U&+$A*SXsTX9UV`GP>*v?KzwZ#4(X;#L@Boy>F#+APX;Vq?Z z-(Gt(&kl7UedO#M)7*@z*=J>Cy(6a~cfWFiClm3wCjFYCQH=y~=kESK*Q~^%V{e*a zAw4bauZbL}V^3S*ov_e?%9S^`TK^w{rzQj45AUG>QPabH*!J3@(0BqKYpBnr=_9cI~Aw+{;00FQY0WKNZr#@ ze61lZ?aG4W3mESco7SMib5miK*As4vKP*4FGQKS@*U;9cgg|og@;WyrDsL()bA9;m z;X8xKbI}m(6pVB(EeP!`t-543N$NehiV3%r!@$Mii$V?!3=FjW_>r_Xi{{gMT~}v>>B)V* zbX(o_NunrPyKQPJ`-t4Z!QnMXr;5J%Y`dm4Gc&V!qX!56@YyqJN_zT)Fv2#v9FeGu z*}?$q$hwkq59eANm6R0Qz*;fOOb`i%F23lP} z+)aL|Z(z{tQiytLXa&-?+YwI_qr?MGVTT?N|7gWdOvD$3?@?_YBd}>sYF_D~K zRFuvvgnTrA#ogWgoUj;0##dcZvN|H*B`;yq0^_ju+6uupOzkdrCd7QYCz0)lKp<+= z3VPG?ijsl??O?vld&u_NxBQdz`n>2R z`Ni-~iwJ-XOz5E-JP>dSH0viIs)dDxP-*AkLQkmu-Ipqc?@b_5DtgeMfw;T8s@|8G7<4IE<=wV^x}Uu zp`1d^EiG3r&IqYls(~9Um0?YFbsde3atI5+i|d1VS{7alpHZJA&p|9KCOWe)8gl(p z)3K^yM`EEU)W^_hBoY~dpS_I?%*xDM2E{|yS5r}8|6%GGjQ7i)_tz6a$9Yv@;l#fY z2Crn3AM{R_?x+G>QnNyMA(VlD{$P)_`%v@*;BeoF~9W%k}em z!u*2Q`dASheDIXEvNFLBRaM=Kk!N(e2m~!tt<_;|Vf8M8x&{dHF<8{&F>Hl%)l)&Sr#{;9v_duF&we*5~5r^ zI4V^?s5Ui~ZVgpx^g~fVho1@hug0_zZ)~vk-2Y@RzM|sRXTn0*eH$CPmqG?|$BW>s zZeqf^skDX1D>Ab&KDN6mN5e6O)~hlloM>pl6e7<c3;hzCGP6 zF?-p2qpq@_kU4{S^7|W=fKS8M3xdsa+0SAyzkmOZ!z3mGsFrQH0uM4-ps!_JmJH7Z z1vi_Mo6}WSSLZtQ&&f?U@)|G~J=u1VxmnM*x3@74-PC&e`rSaL&;RyvQ~9>47MGTm zPGhlHA-a~x3nfo6lAl-J@Krw$aq^(qwq1PEw`gZ)XJB;%7^GbGyz?^Ko^`fjuZPR~ zp|9^p+h#z%cLl0*b7z)>yu!l5h8+d~gkv-V?mPq0qinn)YPZ7suj$#Z>5q<&HAq!2 z4vfVlCA9!NspJ0>N;)Nrh0sm$Nl{B6?QVH;;$5j}Y*HtH{VLYZ3TB9!SB6Fmk5RM>LO9fv~PdJ6~+?rKYD(?el_9+|$sA1;a0Vk`gxm;;47bBP+;GeacgO1lq^(uJnkIt`FnKHvJgtZxaI-U}U*(g(ZC8bkMVV>{CFof_fSE9-~4;iO5f9i zKc56Y9v_G3>FBhJnpN+P7X9%#+OnAa8u{;J{qK}rRQKeh=>w5Wb3?-?XM~+{o7;uk zKEA$CSFf$Dtu8jZaCF^P3Wv;T#G=BI67}cPjY_x-dzQG>Q^0QG|9}G*e)$84&5_3_ zKu7|x4<)G-3IRBVN{q1x`>ceBv^0~X-PZwJw^W9l24O8JHMKk9?8x5GkZ~u6w81i! z=Bn63&q4E+fLmAD*j53W9`8ok+S(q2l^IUX1Ie`u{~M1TKOY&nuM%+@@J)YQp*7q| znxjNqX66R)2;~0nayYmCSQk7}^oSfVU7E5&X>Q#95rdh=U1~xVd zVEAGz0~Ay`LMGSJ z(n3aF3=HU*e-42H%fBJuf+#hb9e5P8z_Tbo!vC|@UPE$}7}C|}u1;FPXDNE&B%X$CFY7uZV{!1%&!2f)zmbXk++jys#VR{^{GgTG z1o=}?UJsp};Yx)J*~$+@SV02s+t%0DuZmxONArD&Ozw6t|L8#WCq&&k61TPWb{?9r zqht-Jv=*e(cKyZ6m%uJ32dLbXP)&sKTC#cQ>(jY3D=I27aB$3Q&doLZ+h3d>z8$0T zJ?R`BePNn?u~AuL9@Y!|Jink|$JR`Jm?9qtB^gL34_aHhyq*l|Wb6pi@o6X~BZCEQ z=;7CVjsCh4EH`w&or3!yZ1=XWnhFsh(}Y{bWg`;aN?}JH=FNTrdPR4ygLXl!azY)n zQ{xj8?Gu$|H-S?e9UVP@yGTk(9-nU3*n{ry?aPyQ{&AQCOc+4|28VZ4Sv7_9hi+7q z^C&8EEJU7pzTsrJ-sJuFV9Y=R&=EgBzfTr4c-vZAS2wn$MajJ0neL`Ihwm91uqns_ zB{HzsST1?5wgTng(5m5wj*cWZZrqUanp2>pqI$Bs>l1P` v 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 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 = 'Sigaldoc' + +html_theme_options = { + 'index_logo': 'logo.png', + 'github_fork': 'saimn/sigal', +} + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Sigal.tex', u'Sigal Documentation', + u'Simon Conseil', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'sigal', u'Sigal Documentation', + [u'Simon Conseil'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Sigal', u'Sigal Documentation', + u'Simon Conseil', 'Sigal', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'Sigal' +epub_author = u'Simon Conseil' +epub_publisher = u'Simon Conseil' +epub_copyright = u'2012, Simon Conseil' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..7ea969c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,147 @@ +======= + Sigal +======= + +Sigal is yet another simple static gallery generator. It's written in Python +and it allows to build a static gallery of images with the following features: + +* process directories recursively, +* resize images and create thumbnails, +* generate html pages using jinja2 templates, +* relative links for a portable output, +* MIT licensed. + +Links + +* Latest documentation on `readthedocs.org`_ +* Source, issues and pull requests on `Github`_ +* Releases on `PyPI`_ + +.. _readthedocs.org: http://sigal.rtfd.org/ +.. _Github: https://github.com/saimn/sigal/ +.. _PyPI: http://pypi.python.org/pypi/sigal + +Installation +------------ + +Install the extension with one of the following commands:: + + $ easy_install sigal + +or alternatively if you have pip installed:: + + $ pip install sigal + +Dependencies +~~~~~~~~~~~~ + +- Python Imaging Library (PIL / Pillow) +- Jinja2 +- Python Markdown +- pyexiv2 (optionnal, used to copy exif metadatas) + +How to Use +---------- + +:: + + $ sigal [-h] [--version] [-f] input_dir output_dir + +Required arguments: + +``input_dir`` + input directory + +``output_dir`` + output directory + +Optional arguments: + +``-h|--help`` + Show this help message and exit + +``--version`` + Show program's version number and exit + +``-f|--force`` + Force the reprocessing of existing images and thumbnails + +``-v, --verbose`` + Show all messages + +``-d, --debug`` + Show all message, including debug messages + +Configuration +------------- + +The configuration for the gallery must be set in ``/sigal.conf``. + +.. code-block:: ini + + [sigal] + + # theme + theme = default + + # size of resized image + img_size = 640x480 + + # generate thumbnails + make_thumbs = 1 + + # directory of the thumbnails + thumb_dir = thumbnail + + # prefix for thumbnails name + thumb_prefix = tn- + + # thumbnail size + thumb_size = 200x150 + + # crop the image to fill the box + thumb_fit = 1 + + # keep big image + big_img = 1 + bigimg_dir = original + + # jpeg quality + jpg_quality = 90 + + # keep exif metadatas in output image + exif = 1 + + # add a copyright text on the image + copyright = An example copyright message + + +Album information +----------------- + +Information on an album can be given in a file using the markdown syntax, +named `index.mkd` :: + + Title: Another example gallery + Representative: test2.jpg + + And a *cool* description. + +If this file does not exist the directory's name is used for the title, and +the first image of the directory is used as representative. + +Credits +------- + +* galleria: http://galleria.aino.se/ +* WordPress Photography Theme: http://thethemefoundry.com/photography/ + +Changelog +--------- + +Version 0.1 +~~~~~~~~~~~ + +Released on 2012-05-13. + +First public release. diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..2225c44 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,190 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ 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. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over 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 + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Sigal.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Sigal.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end