-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
1,117 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
Copyright (c) 2010 by Armin Ronacher. | ||
|
||
Some rights reserved. | ||
|
||
Redistribution and use in source and binary forms of the theme, with or | ||
without modification, are permitted provided that the following conditions | ||
are met: | ||
|
||
* Redistributions of source code must retain the above copyright | ||
notice, this list of conditions and the following disclaimer. | ||
|
||
* Redistributions in binary form must reproduce the above | ||
copyright notice, this list of conditions and the following | ||
disclaimer in the documentation and/or other materials provided | ||
with the distribution. | ||
|
||
* The names of the contributors may not be used to endorse or | ||
promote products derived from this software without specific | ||
prior written permission. | ||
|
||
We kindly ask you to only use these themes in an unmodified manner just | ||
for Flask and Flask-related products, not for unrelated projects. If you | ||
like the visual style and want to use it for your own projects, please | ||
consider making some larger changes to the themes (such as changing | ||
font faces, sizes, colors or margins). | ||
|
||
THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | ||
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE | ||
POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
Flask Sphinx Styles | ||
=================== | ||
|
||
This repository contains sphinx styles for Flask and Flask related | ||
projects. To use this style 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 = 'flask' | ||
|
||
The following themes exist: | ||
|
||
- 'flask' - the standard flask documentation theme for large | ||
projects | ||
- 'flask_small' - small one-page theme. Intended to be used by | ||
very small addon libraries for flask. | ||
|
||
The following options exist for the flask_small theme: | ||
|
||
[options] | ||
index_logo = '' filename of a picture in _static | ||
to be used as replacement for the | ||
h1 in the index.rst file. | ||
index_logo_height = 120px height of the index logo | ||
github_fork = '' repository name on github for the | ||
"fork me" badge |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{%- extends "basic/layout.html" %} | ||
{%- block extrahead %} | ||
{{ super() }} | ||
{% if theme_touch_icon %} | ||
<link rel="apple-touch-icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" /> | ||
{% endif %} | ||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> | ||
{% endblock %} | ||
{%- block relbar2 %}{% endblock %} | ||
{% block header %} | ||
{{ super() }} | ||
{% if pagename == 'index' %} | ||
<div class=indexwrapper> | ||
{% endif %} | ||
{% endblock %} | ||
{%- block footer %} | ||
<div class="footer"> | ||
© Copyright {{ copyright }}. | ||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>. | ||
</div> | ||
{% if pagename == 'index' %} | ||
</div> | ||
{% endif %} | ||
{%- endblock %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<h3>Related Topics</h3> | ||
<ul> | ||
<li><a href="{{ pathto(master_doc) }}">Documentation overview</a><ul> | ||
{%- for parent in parents %} | ||
<li><a href="{{ parent.link|e }}">{{ parent.title }}</a><ul> | ||
{%- endfor %} | ||
{%- if prev %} | ||
<li>Previous: <a href="{{ prev.link|e }}" title="{{ _('previous chapter') | ||
}}">{{ prev.title }}</a></li> | ||
{%- endif %} | ||
{%- if next %} | ||
<li>Next: <a href="{{ next.link|e }}" title="{{ _('next chapter') | ||
}}">{{ next.title }}</a></li> | ||
{%- endif %} | ||
{%- for parent in parents %} | ||
</ul></li> | ||
{%- endfor %} | ||
</ul></li> | ||
</ul> |
Oops, something went wrong.