From 79421df5cd3ec870e2ccfd18ed0cb69ef9a5f8e3 Mon Sep 17 00:00:00 2001 From: Matt Good Date: Thu, 21 Feb 2013 13:36:29 -0800 Subject: [PATCH] Use Flask theme for the documentation --- .gitmodules | 3 +++ docs/_themes | 1 + docs/conf.py | 14 +++++++++----- docs/index.rst | 4 ++-- 4 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 .gitmodules create mode 160000 docs/_themes diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..bf7b494 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "docs/_themes"] + path = docs/_themes + url = git://github.com/mitsuhiko/flask-sphinx-themes.git diff --git a/docs/_themes b/docs/_themes new file mode 160000 index 0000000..0269f3d --- /dev/null +++ b/docs/_themes @@ -0,0 +1 @@ +Subproject commit 0269f3d188eaff07c44a800f35f7351f9e0aefb0 diff --git a/docs/conf.py b/docs/conf.py index 71a6180..ea8aab7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ copyright = u'2012, Matt Good' # built documents. # # The short X.Y version. -version = '0.7' +version = '0.8' # The full version, including alpha/beta/rc tags. -release = '0.7.1' +release = '0.8.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -91,15 +91,19 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'flask_small' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = { + 'github_fork': 'mgood/flask-debugtoolbar', + 'index_logo': None, +} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +sys.path.append(os.path.abspath('_themes')) +html_theme_path = ['_themes'] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/docs/index.rst b/docs/index.rst index e080ef8..2982d40 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Flask-DebugToolbar's documentation! -============================================== +Flask-DebugToolbar +================== This is a port of the excellent `django-debug-toolbar `_ for Flask applications.