Permalink
Browse files

Renamed Spirits -> Flask-Themes2, as well as began cleanup of extension.

  • Loading branch information...
1 parent 1eb6c50 commit 3d43944fc33c24e7af6a1cdde2d7aa546f4ae9f3 @sysr-q committed Feb 11, 2013
Showing with 387 additions and 163 deletions.
  1. +36 −7 .gitignore
  2. +1 −1 LICENSE
  3. +0 −20 README
  4. +31 −0 README.rst
  5. +79 −15 docs/Makefile
  6. +76 −30 docs/conf.py
  7. +6 −6 docs/index.rst
  8. +90 −13 docs/make.bat
  9. +5 −5 example/posts.yaml
  10. +2 −3 example/themesandbox.py
  11. +20 −10 {spirits → flask_themes2}/__init__.py
  12. +1 −0 flask_themes2/themes2.py
  13. +37 −50 setup.py
  14. +3 −3 tests/test-themes.py
View
@@ -1,7 +1,36 @@
-*~
-*.pyc
-*.pyo
-docs/_build/*
-*egg-info*
-dist/*
-env/*
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+_build
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
View
@@ -1,4 +1,4 @@
-Copyright (c) 2010 Matthew "LeafStorm" Frazier
+Copyright (c) 2013 Christopher Carter, 2010 Matthew "LeafStorm" Frazier
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
View
@@ -1,20 +0,0 @@
-Spirits (for Flask)
-
-A fork of the Spirits package for Flask maintained by Drew Lustro.
-Originally by Matthew "LeafStorm" Frazier <leafstormrush@gmail.com>
-
-This provides infrastructure for themes in Flask.
-
-Installation
-
-pip install -e git://github.com/drewlustro/spirits.git#egg=spirits
-
-Documentation
-
-pip install sphinx
-pip install -e git://github.com/drewlustro/spirits.git#egg=spirits
-git clone git://github.com/drewlustro/spirits.git
-cd spirits/docs
-make html
-
-The documentation will be in generated in a directory called _build/
View
@@ -0,0 +1,31 @@
+Flask-Themes2
+=============
+
+Flask-Themes2 is a fork of Spirits, which is in turn a fork of Flask-Themes.
+
+- `Spirits <https://github.com/drewlustro/spirits>`_ maintained by Drew Lustro
+- `Flask-Themes <https://bitbucket.org/leafstorm/flask-themes>`_ by Matthew "LeafStorm" Frazier
+
+This provides infrastructure for themes in Flask.
+
+Installation
+------------
+
+.. code-block:: sh
+
+ $ pip install -e git://github.com/plausibility/Flask-Themes2.git#egg=flask_themes2-X.Y.Z
+
+Documentation
+-------------
+
+Once the project is worthy, I will upload it to RTD.
+
+.. code-block:: sh
+
+ $ pip install sphinx
+ $ pip install -e git://github.com/plausibility/Flask-Themes2.git#egg=flask_themes2-X.Y.Z
+ $ git clone git://github.com/plausibility/Flask-Themes2.git
+ $ cd Flask-Themes2/docs
+ $ make html
+
+The documentation will be in generated in a directory called ``_build/``
View
@@ -11,21 +11,32 @@ BUILDDIR = _build
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 pickle json htmlhelp qthelp latex changes linkcheck doctest
+.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 " 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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @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)"
+ @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)/*
@@ -40,6 +51,11 @@ 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
@@ -61,16 +77,64 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Spirits.qhcp"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Flask-Themes2.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Flask-Themes2.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
@echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Spirits.qhc"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/Flask-Themes2"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Flask-Themes2"
+ @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 all-pdf' or \`make all-ps' in that directory to" \
- "run these through (pdf)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
Oops, something went wrong.

0 comments on commit 3d43944

Please sign in to comment.