From 957548026a0b8580fc867c595f278598779124f9 Mon Sep 17 00:00:00 2001 From: Blaise Laflamme Date: Sun, 31 Oct 2010 14:30:07 -0400 Subject: Updated doc template as a theme - look at pylons_sphinx_theme --- docs/Makefile | 56 ++--- docs/_static/logo_hi.png | Bin 3693 -> 0 bytes docs/_themes/LICENSE | 0 docs/_themes/README | 18 ++ docs/_themes/pylons/layout.html | 22 ++ docs/_themes/pylons/static/exclaim.png | Bin 0 -> 3542 bytes docs/_themes/pylons/static/exclaim_color.png | Bin 0 -> 3432 bytes docs/_themes/pylons/static/favicon.ico | Bin 0 -> 1406 bytes .../_themes/pylons/static/fonts/nobile-webfont.eot | Bin 0 -> 25356 bytes .../_themes/pylons/static/fonts/nobile-webfont.svg | 142 +++++++++++ .../_themes/pylons/static/fonts/nobile-webfont.ttf | Bin 0 -> 25124 bytes .../pylons/static/fonts/nobile-webfont.woff | Bin 0 -> 17600 bytes .../pylons/static/fonts/nobile_bold-webfont.eot | Bin 0 -> 23588 bytes .../pylons/static/fonts/nobile_bold-webfont.svg | 141 +++++++++++ .../pylons/static/fonts/nobile_bold-webfont.ttf | Bin 0 -> 23368 bytes .../pylons/static/fonts/nobile_bold-webfont.woff | Bin 0 -> 16712 bytes .../static/fonts/nobile_bold_italic-webfont.eot | Bin 0 -> 25628 bytes .../static/fonts/nobile_bold_italic-webfont.svg | 141 +++++++++++ .../static/fonts/nobile_bold_italic-webfont.ttf | Bin 0 -> 25380 bytes .../static/fonts/nobile_bold_italic-webfont.woff | Bin 0 -> 17824 bytes .../pylons/static/fonts/nobile_italic-webfont.eot | Bin 0 -> 30184 bytes .../pylons/static/fonts/nobile_italic-webfont.svg | 141 +++++++++++ .../pylons/static/fonts/nobile_italic-webfont.ttf | Bin 0 -> 29956 bytes .../pylons/static/fonts/nobile_italic-webfont.woff | Bin 0 -> 20128 bytes docs/_themes/pylons/static/info.png | Bin 0 -> 3844 bytes docs/_themes/pylons/static/info_color.png | Bin 0 -> 3810 bytes docs/_themes/pylons/static/nobile.css | 36 +++ docs/_themes/pylons/static/onebit_36.png | Bin 0 -> 1705 bytes docs/_themes/pylons/static/onebit_38.png | Bin 0 -> 1937 bytes docs/_themes/pylons/static/pylons.css_t | 266 +++++++++++++++++++++ docs/_themes/pylons/static/pylons.png | Bin 0 -> 4063 bytes docs/_themes/pylons/theme.conf | 4 + docs/_themes/pylons_theme_support.py | 102 ++++++++ docs/build_book | 2 +- docs/conf.py | 13 +- 35 files changed, 1050 insertions(+), 34 deletions(-) delete mode 100644 docs/_static/logo_hi.png create mode 100644 docs/_themes/LICENSE create mode 100644 docs/_themes/README create mode 100644 docs/_themes/pylons/layout.html create mode 100644 docs/_themes/pylons/static/exclaim.png create mode 100644 docs/_themes/pylons/static/exclaim_color.png create mode 100644 docs/_themes/pylons/static/favicon.ico create mode 100644 docs/_themes/pylons/static/fonts/nobile-webfont.eot create mode 100644 docs/_themes/pylons/static/fonts/nobile-webfont.svg create mode 100644 docs/_themes/pylons/static/fonts/nobile-webfont.ttf create mode 100644 docs/_themes/pylons/static/fonts/nobile-webfont.woff create mode 100644 docs/_themes/pylons/static/fonts/nobile_bold-webfont.eot create mode 100644 docs/_themes/pylons/static/fonts/nobile_bold-webfont.svg create mode 100644 docs/_themes/pylons/static/fonts/nobile_bold-webfont.ttf create mode 100644 docs/_themes/pylons/static/fonts/nobile_bold-webfont.woff create mode 100644 docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.eot create mode 100644 docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.svg create mode 100644 docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.ttf create mode 100644 docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.woff create mode 100644 docs/_themes/pylons/static/fonts/nobile_italic-webfont.eot create mode 100644 docs/_themes/pylons/static/fonts/nobile_italic-webfont.svg create mode 100644 docs/_themes/pylons/static/fonts/nobile_italic-webfont.ttf create mode 100644 docs/_themes/pylons/static/fonts/nobile_italic-webfont.woff create mode 100644 docs/_themes/pylons/static/info.png create mode 100644 docs/_themes/pylons/static/info_color.png create mode 100644 docs/_themes/pylons/static/nobile.css create mode 100755 docs/_themes/pylons/static/onebit_36.png create mode 100755 docs/_themes/pylons/static/onebit_38.png create mode 100644 docs/_themes/pylons/static/pylons.css_t create mode 100644 docs/_themes/pylons/static/pylons.png create mode 100644 docs/_themes/pylons/theme.conf create mode 100644 docs/_themes/pylons_theme_support.py diff --git a/docs/Makefile b/docs/Makefile index f150b5ea4..768efb9df 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -9,7 +9,7 @@ PAPER = # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d .build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html web pickle htmlhelp latex changes linkcheck @@ -23,63 +23,63 @@ help: @echo " linkcheck to check all external links for integrity" clean: - -rm -rf .build/* + -rm -rf _build/* html: - mkdir -p .build/html .build/doctrees - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html + mkdir -p _build/html _build/doctrees + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html @echo - @echo "Build finished. The HTML pages are in .build/html." + @echo "Build finished. The HTML pages are in _build/html." text: - mkdir -p .build/text .build/doctrees - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) .build/text + mkdir -p _build/text _build/doctrees + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text @echo - @echo "Build finished. The HTML pages are in .build/text." + @echo "Build finished. The HTML pages are in _build/text." pickle: - mkdir -p .build/pickle .build/doctrees - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle + mkdir -p _build/pickle _build/doctrees + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle @echo @echo "Build finished; now you can process the pickle files or run" - @echo " sphinx-web .build/pickle" + @echo " sphinx-web _build/pickle" @echo "to start the sphinx-web server." web: pickle htmlhelp: - mkdir -p .build/htmlhelp .build/doctrees - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp + mkdir -p _build/htmlhelp _build/doctrees + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in .build/htmlhelp." + ".hhp project file in _build/htmlhelp." latex: - mkdir -p .build/latex .build/doctrees - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex - cp _static/*.png .build/latex + mkdir -p _build/latex _build/doctrees + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex + cp _static/*.png _build/latex ./convert_images.sh - cp _static/exclaim.png .build/latex - cp _static/info.png .build/latex + cp _static/exclaim.png _build/latex + cp _static/info.png _build/latex @echo - @echo "Build finished; the LaTeX files are in .build/latex." + @echo "Build finished; the LaTeX files are in _build/latex." @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ "run these through (pdf)latex." changes: - mkdir -p .build/changes .build/doctrees - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes + mkdir -p _build/changes _build/doctrees + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes @echo - @echo "The overview file is in .build/changes." + @echo "The overview file is in _build/changes." linkcheck: - mkdir -p .build/linkcheck .build/doctrees - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck + mkdir -p _build/linkcheck _build/doctrees + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ - "or in .build/linkcheck/output.txt." + "or in _build/linkcheck/output.txt." epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) .build/epub + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) _build/epub @echo - @echo "Build finished. The epub file is in .build/epub." + @echo "Build finished. The epub file is in _build/epub." diff --git a/docs/_static/logo_hi.png b/docs/_static/logo_hi.png deleted file mode 100644 index 996dcac4f..000000000 Binary files a/docs/_static/logo_hi.png and /dev/null differ diff --git a/docs/_themes/LICENSE b/docs/_themes/LICENSE new file mode 100644 index 000000000..e69de29bb diff --git a/docs/_themes/README b/docs/_themes/README new file mode 100644 index 000000000..d5a27a7c7 --- /dev/null +++ b/docs/_themes/README @@ -0,0 +1,18 @@ +Pylons Sphinx Theme +=================== + +This repository contains Pylons themes for Pylons related projects. +To use a theme in your Sphinx documentation, follow this guide: + +1. put this folder as _themes into your docs folder. Alternatively + you can also use git submodules to check out the contents there. +2. add this to your conf.py: + + sys.path.append(os.path.abspath('_themes')) + html_theme_path = ['_themes'] + html_theme = 'pylons' + +The following themes exist: + +- 'pylons' - the standard Pylons documentation theme for large + projects diff --git a/docs/_themes/pylons/layout.html b/docs/_themes/pylons/layout.html new file mode 100644 index 000000000..f3f00cf13 --- /dev/null +++ b/docs/_themes/pylons/layout.html @@ -0,0 +1,22 @@ +{% extends "basic/layout.html" %} + +{%- block extrahead %} +{%- if not favicon %} + +{%- endif %} +{% endblock %} + +{%- block sidebarlogo %} + +{%- if logo %} + +{%- endif %} +{%- endblock %} \ No newline at end of file diff --git a/docs/_themes/pylons/static/exclaim.png b/docs/_themes/pylons/static/exclaim.png new file mode 100644 index 000000000..6707bc362 Binary files /dev/null and b/docs/_themes/pylons/static/exclaim.png differ diff --git a/docs/_themes/pylons/static/exclaim_color.png b/docs/_themes/pylons/static/exclaim_color.png new file mode 100644 index 000000000..dffff8784 Binary files /dev/null and b/docs/_themes/pylons/static/exclaim_color.png differ diff --git a/docs/_themes/pylons/static/favicon.ico b/docs/_themes/pylons/static/favicon.ico new file mode 100644 index 000000000..71f837c9e Binary files /dev/null and b/docs/_themes/pylons/static/favicon.ico differ diff --git a/docs/_themes/pylons/static/fonts/nobile-webfont.eot b/docs/_themes/pylons/static/fonts/nobile-webfont.eot new file mode 100644 index 000000000..2dd2488ff Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile-webfont.eot differ diff --git a/docs/_themes/pylons/static/fonts/nobile-webfont.svg b/docs/_themes/pylons/static/fonts/nobile-webfont.svg new file mode 100644 index 000000000..02821e5ad --- /dev/null +++ b/docs/_themes/pylons/static/fonts/nobile-webfont.svg @@ -0,0 +1,142 @@ + + + + +This is a custom SVG webfont generated by Font Squirrel. +Foundry : vernon adams + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/_themes/pylons/static/fonts/nobile-webfont.ttf b/docs/_themes/pylons/static/fonts/nobile-webfont.ttf new file mode 100644 index 000000000..f14553789 Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile-webfont.ttf differ diff --git a/docs/_themes/pylons/static/fonts/nobile-webfont.woff b/docs/_themes/pylons/static/fonts/nobile-webfont.woff new file mode 100644 index 000000000..487653bac Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile-webfont.woff differ diff --git a/docs/_themes/pylons/static/fonts/nobile_bold-webfont.eot b/docs/_themes/pylons/static/fonts/nobile_bold-webfont.eot new file mode 100644 index 000000000..a29f29384 Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile_bold-webfont.eot differ diff --git a/docs/_themes/pylons/static/fonts/nobile_bold-webfont.svg b/docs/_themes/pylons/static/fonts/nobile_bold-webfont.svg new file mode 100644 index 000000000..f519c36d8 --- /dev/null +++ b/docs/_themes/pylons/static/fonts/nobile_bold-webfont.svg @@ -0,0 +1,141 @@ + + + + +This is a custom SVG webfont generated by Font Squirrel. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/_themes/pylons/static/fonts/nobile_bold-webfont.ttf b/docs/_themes/pylons/static/fonts/nobile_bold-webfont.ttf new file mode 100644 index 000000000..e0ab8b44f Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile_bold-webfont.ttf differ diff --git a/docs/_themes/pylons/static/fonts/nobile_bold-webfont.woff b/docs/_themes/pylons/static/fonts/nobile_bold-webfont.woff new file mode 100644 index 000000000..59ea975d4 Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile_bold-webfont.woff differ diff --git a/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.eot b/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.eot new file mode 100644 index 000000000..70fd740e6 Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.eot differ diff --git a/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.svg b/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.svg new file mode 100644 index 000000000..34a4cc554 --- /dev/null +++ b/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.svg @@ -0,0 +1,141 @@ + + + + +This is a custom SVG webfont generated by Font Squirrel. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.ttf b/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.ttf new file mode 100644 index 000000000..14da4e95f Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.ttf differ diff --git a/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.woff b/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.woff new file mode 100644 index 000000000..ec3a52274 Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile_bold_italic-webfont.woff differ diff --git a/docs/_themes/pylons/static/fonts/nobile_italic-webfont.eot b/docs/_themes/pylons/static/fonts/nobile_italic-webfont.eot new file mode 100644 index 000000000..61ab01727 Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile_italic-webfont.eot differ diff --git a/docs/_themes/pylons/static/fonts/nobile_italic-webfont.svg b/docs/_themes/pylons/static/fonts/nobile_italic-webfont.svg new file mode 100644 index 000000000..ef7c5e1da --- /dev/null +++ b/docs/_themes/pylons/static/fonts/nobile_italic-webfont.svg @@ -0,0 +1,141 @@ + + + + +This is a custom SVG webfont generated by Font Squirrel. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/_themes/pylons/static/fonts/nobile_italic-webfont.ttf b/docs/_themes/pylons/static/fonts/nobile_italic-webfont.ttf new file mode 100644 index 000000000..d67095bfb Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile_italic-webfont.ttf differ diff --git a/docs/_themes/pylons/static/fonts/nobile_italic-webfont.woff b/docs/_themes/pylons/static/fonts/nobile_italic-webfont.woff new file mode 100644 index 000000000..62ecb1ecc Binary files /dev/null and b/docs/_themes/pylons/static/fonts/nobile_italic-webfont.woff differ diff --git a/docs/_themes/pylons/static/info.png b/docs/_themes/pylons/static/info.png new file mode 100644 index 000000000..95d00a973 Binary files /dev/null and b/docs/_themes/pylons/static/info.png differ diff --git a/docs/_themes/pylons/static/info_color.png b/docs/_themes/pylons/static/info_color.png new file mode 100644 index 000000000..bcaf288bd Binary files /dev/null and b/docs/_themes/pylons/static/info_color.png differ diff --git a/docs/_themes/pylons/static/nobile.css b/docs/_themes/pylons/static/nobile.css new file mode 100644 index 000000000..26da42be4 --- /dev/null +++ b/docs/_themes/pylons/static/nobile.css @@ -0,0 +1,36 @@ +/* Generated by Font Squirrel (http://www.fontsquirrel.com) on October 30, 2010 05:02:55 PM America/New_York */ + + + +@font-face { + font-family: 'NobileRegular'; + src: url('fonts/nobile-webfont.eot'); + src: local('☺'), url('fonts/nobile-webfont.woff') format('woff'), url('fonts/nobile-webfont.ttf') format('truetype'), url('fonts/nobile-webfont.svg#webfontJRE3eIdv') format('svg'); + font-weight: normal; + font-style: normal; +} + +@font-face { + font-family: 'NobileItalic'; + src: url('fonts/nobile_italic-webfont.eot'); + src: local('☺'), url('fonts/nobile_italic-webfont.woff') format('woff'), url('fonts/nobile_italic-webfont.ttf') format('truetype'), url('fonts/nobile_italic-webfont.svg#webfonttYQJ7lut') format('svg'); + font-weight: normal; + font-style: normal; +} + +@font-face { + font-family: 'NobileBold'; + src: url('fonts/nobile_bold-webfont.eot'); + src: local('☺'), url('fonts/nobile_bold-webfont.woff') format('woff'), url('fonts/nobile_bold-webfont.ttf') format('truetype'), url('fonts/nobile_bold-webfont.svg#webfontCQ83cnWY') format('svg'); + font-weight: normal; + font-style: normal; +} + +@font-face { + font-family: 'NobileBoldItalic'; + src: url('fonts/nobile_bold_italic-webfont.eot'); + src: local('☺'), url('fonts/nobile_bold_italic-webfont.woff') format('woff'), url('fonts/nobile_bold_italic-webfont.ttf') format('truetype'), url('fonts/nobile_bold_italic-webfont.svg#webfontKoZkTjJU') format('svg'); + font-weight: normal; + font-style: normal; +} + diff --git a/docs/_themes/pylons/static/onebit_36.png b/docs/_themes/pylons/static/onebit_36.png new file mode 100755 index 000000000..70889fc16 Binary files /dev/null and b/docs/_themes/pylons/static/onebit_36.png differ diff --git a/docs/_themes/pylons/static/onebit_38.png b/docs/_themes/pylons/static/onebit_38.png new file mode 100755 index 000000000..4dcf07651 Binary files /dev/null and b/docs/_themes/pylons/static/onebit_38.png differ diff --git a/docs/_themes/pylons/static/pylons.css_t b/docs/_themes/pylons/static/pylons.css_t new file mode 100644 index 000000000..91b840535 --- /dev/null +++ b/docs/_themes/pylons/static/pylons.css_t @@ -0,0 +1,266 @@ +/* + * pylons.css_t + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- pylons theme. + * + * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); +@import url("nobile.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: "Nobile", sans-serif; + font-size: 100%; + background-color: #111; + color: #ffffff; + margin: 0; + padding: 0; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 230px; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.document { + background-color: #eee; +} + +div.body { + background-color: #ffffff; + color: #3E4349; + padding: 0 30px 30px 30px; + font-size: 1em; +} + +div.footer { + color: #ffffff; + width: 100%; + padding: 13px 0; + text-align: center; + font-size: 75%; +} + +div.footer a { + color: #ffffff; + text-decoration: none; +} + +div.footer a:hover { + color: #e88f00; + text-decoration: underline; +} + +div.related { + background-color: #e88f00; + line-height: 32px; + color: #ffffff; + /*text-shadow: 0px 1px 0 #777;*/ + font-size: 0.9em; +} + +div.related a { + color: #ffffff; +} + +div.sphinxsidebar { + font-size: 0.75em; + line-height: 1.5em; +} + +div.sphinxsidebarwrapper{ + padding: 20px 0; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: "Nobile", sans-serif; + color: #000000; + font-size: 1.2em; + font-weight: normal; + margin: 0; + padding: 5px 10px; + background-color: #ddd; + /*text-shadow: 1px 1px 0 white*/ +} + +div.sphinxsidebar h4{ + font-size: 1.1em; +} + +div.sphinxsidebar h3 a { + color: #000000; +} + + +div.sphinxsidebar p { + color: #888; + padding: 5px 20px; +} + +div.sphinxsidebar p.topless { +} + +div.sphinxsidebar ul { + margin: 10px 20px; + padding: 0; + color: #000; +} + +div.sphinxsidebar a { + color: #444; +} + +div.sphinxsidebar input { + border: 1px solid #ccc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar input[type=text]{ + margin-left: 20px; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #fef6ea; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- body styles ----------------------------------------------------------- */ + +a, a .pre { + color: #1b61d6; + text-decoration: none; +} + +a:hover, a:hover .pre { + color: #e88f00; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: "Nobile", sans-serif; + background-color: #ffffff; + font-weight: normal; + color: #144fb2; + margin: 30px 0px 10px 0px; + padding: 5px 0; + /*text-shadow: 0px 1px 0 white*/ +} + +div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; } +div.body h2 { font-size: 150%; background-color: #ffffff; } +div.body h3 { font-size: 120%; background-color: #ffffff; } +div.body h4 { font-size: 110%; background-color: #ffffff; } +div.body h5 { font-size: 100%; background-color: #ffffff; } +div.body h6 { font-size: 100%; background-color: #ffffff; } + +a.headerlink { + color: #e88f00; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + background-color: #e88f00; + color: white; +} + +div.body p, div.body dd, div.body li { + line-height: 1.5em; +} + +div.admonition p.admonition-title + p { + display: inline; +} + +div.highlight{ + background-color: white; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +div.topic { + background-color: #eee; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre { + padding: 10px; + background-color: White; + color: #222; + line-height: 1.2em; + border: 1px solid #C6C9CB; + font-size: 1.1em; + margin: 1.5em 0 1.5em 0; + border-right-style: none; + border-left-style: none; +} + +tt { + background-color: transparent; + color: #222; + /* padding: 1px 2px; */ + font-size: 1.1em; + font-family: monospace; +} + +.viewcode-back { + font-family: "Nobile", sans-serif; +} + +div.viewcode-block:target { + background-color: #f2e8c4; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} \ No newline at end of file diff --git a/docs/_themes/pylons/static/pylons.png b/docs/_themes/pylons/static/pylons.png new file mode 100644 index 000000000..53f83e4d0 Binary files /dev/null and b/docs/_themes/pylons/static/pylons.png differ diff --git a/docs/_themes/pylons/theme.conf b/docs/_themes/pylons/theme.conf new file mode 100644 index 000000000..3c3f85e48 --- /dev/null +++ b/docs/_themes/pylons/theme.conf @@ -0,0 +1,4 @@ +[theme] +inherit = basic +stylesheet = pylons.css +pygments_style = pylons_theme_support.PylonsStyle diff --git a/docs/_themes/pylons_theme_support.py b/docs/_themes/pylons_theme_support.py new file mode 100644 index 000000000..b63df3626 --- /dev/null +++ b/docs/_themes/pylons_theme_support.py @@ -0,0 +1,102 @@ +# -*- coding: utf-8 -*- +from pygments.style import Style +from pygments.token import Keyword, Name, Comment, String, Error, \ + Number, Operator, Generic, Whitespace, Punctuation, Other, Literal + + +class PylonsStyle(Style): + """ + Pylons pygments style based on tango style + """ + + # work in progress... + + background_color = "#f8f8f8" + default_style = "" + + styles = { + # No corresponding class for the following: + #Text: "", # class: '' + Whitespace: "underline #f8f8f8", # class: 'w' + Error: "#a40000 border:#ef2929", # class: 'err' + Other: "#000000", # class 'x' + + Comment: "italic #8f5902", # class: 'c' + Comment.Multiline: "italic #8f5902", # class: 'cm' + Comment.Preproc: "italic #8f5902", # class: 'cp' + Comment.Single: "italic #8f5902", # class: 'c1' + Comment.Special: "italic #8f5902", # class: 'cs' + + Keyword: "bold #204a87", # class: 'k' + Keyword.Constant: "bold #204a87", # class: 'kc' + Keyword.Declaration: "bold #204a87", # class: 'kd' + Keyword.Namespace: "bold #204a87", # class: 'kn' + Keyword.Pseudo: "bold #204a87", # class: 'kp' + Keyword.Reserved: "bold #204a87", # class: 'kr' + Keyword.Type: "bold #204a87", # class: 'kt' + + Operator: "bold #ce5c00", # class: 'o' + Operator.Word: "bold #204a87", # class: 'ow' - like keywords + + Punctuation: "bold #000000", # class: 'p' + + # because special names such as Name.Class, Name.Function, etc. + # are not recognized as such later in the parsing, we choose them + # to look the same as ordinary variables. + Name: "#000000", # class: 'n' + Name.Attribute: "#c4a000", # class: 'na' - to be revised + Name.Builtin: "#204a87", # class: 'nb' + Name.Builtin.Pseudo: "#3465a4", # class: 'bp' + Name.Class: "#000000", # class: 'nc' - to be revised + Name.Constant: "#000000", # class: 'no' - to be revised + Name.Decorator: "bold #5c35cc", # class: 'nd' - to be revised + Name.Entity: "#ce5c00", # class: 'ni' + Name.Exception: "bold #cc0000", # class: 'ne' + Name.Function: "#000000", # class: 'nf' + Name.Property: "#000000", # class: 'py' + Name.Label: "#f57900", # class: 'nl' + Name.Namespace: "#000000", # class: 'nn' - to be revised + Name.Other: "#000000", # class: 'nx' + Name.Tag: "bold #204a87", # class: 'nt' - like a keyword + Name.Variable: "#000000", # class: 'nv' - to be revised + Name.Variable.Class: "#000000", # class: 'vc' - to be revised + Name.Variable.Global: "#000000", # class: 'vg' - to be revised + Name.Variable.Instance: "#000000", # class: 'vi' - to be revised + + # since the tango light blue does not show up well in text, we choose + # a pure blue instead. + Number: "bold #0000cf", # class: 'm' + Number.Float: "bold #0000cf", # class: 'mf' + Number.Hex: "bold #0000cf", # class: 'mh' + Number.Integer: "bold #0000cf", # class: 'mi' + Number.Integer.Long: "bold #0000cf", # class: 'il' + Number.Oct: "bold #0000cf", # class: 'mo' + + Literal: "#000000", # class: 'l' + Literal.Date: "#000000", # class: 'ld' + + String: "#4e9a06", # class: 's' + String.Backtick: "#4e9a06", # class: 'sb' + String.Char: "#4e9a06", # class: 'sc' + String.Doc: "italic #8f5902", # class: 'sd' - like a comment + String.Double: "#4e9a06", # class: 's2' + String.Escape: "#4e9a06", # class: 'se' + String.Heredoc: "#4e9a06", # class: 'sh' + String.Interpol: "#4e9a06", # class: 'si' + String.Other: "#4e9a06", # class: 'sx' + String.Regex: "#4e9a06", # class: 'sr' + String.Single: "#4e9a06", # class: 's1' + String.Symbol: "#4e9a06", # class: 'ss' + + Generic: "#000000", # class: 'g' + Generic.Deleted: "#a40000", # class: 'gd' + Generic.Emph: "italic #000000", # class: 'ge' + Generic.Error: "#ef2929", # class: 'gr' + Generic.Heading: "bold #000080", # class: 'gh' + Generic.Inserted: "#00A000", # class: 'gi' + Generic.Output: "italic #000000", # class: 'go' + Generic.Prompt: "#8f5902", # class: 'gp' + Generic.Strong: "bold #000000", # class: 'gs' + Generic.Subheading: "bold #800080", # class: 'gu' + Generic.Traceback: "bold #a40000", # class: 'gt' + } diff --git a/docs/build_book b/docs/build_book index 771da7dd3..d79de4e59 100755 --- a/docs/build_book +++ b/docs/build_book @@ -1,4 +1,4 @@ #!/bin/sh BOOK=1 make clean latex -cd .build/latex +cd _build/latex make all diff --git a/docs/conf.py b/docs/conf.py index bc424b111..5b1447a21 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,17 +93,20 @@ add_module_names = False #show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = book and 'bw' or 'tango' +#pygments_style = book and 'bw' or 'tango' # Options for HTML output # ----------------------- -html_theme = "nature" +# Add and use Pylons theme +sys.path.append(os.path.abspath('_themes')) +html_theme_path = ['_themes'] +html_theme = 'pylons' # The style sheet to use for HTML and HTML Help pages. A file of that name # must exist either in Sphinx' static/ path, or in one of the custom paths # given in html_static_path. -html_style = 'pyramid.css' +#html_style = 'pyramid.css' # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -114,12 +117,12 @@ html_title = 'The Pyramid Web Application Development Framework v%s' % release # The name of an image file (within the static path) to place at the top of # the sidebar. -html_logo = '_static/pyramid.png' +#html_logo = '_static/pylons.png' # 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 +#html_favicon = '_static/favicon.ico' # 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, -- cgit v1.2.3