Skip to content

Commit

Permalink
[master,doc][s]: switch docs theme to sphinx-theme-okfn and tweak con…
Browse files Browse the repository at this point in the history
…fig (e.g. project title).
  • Loading branch information
rufuspollock committed Mar 1, 2012
1 parent 730c0ac commit b0885bb
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 35 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
@@ -0,0 +1,3 @@
[submodule "doc/_themes/sphinx-theme-okfn"]
path = doc/_themes/sphinx-theme-okfn
url = git://github.com/okfn/sphinx-theme-okfn.git
29 changes: 29 additions & 0 deletions doc/_templates/footer.html
@@ -0,0 +1,29 @@
<p>An <a href="http://okfn.org">Open Knowledge Foundation</a> project.</p>

<p class="copyright">
{%- if show_copyright %}
{% trans copyright=copyright|safe|e %}{{ copyright }}{% endtrans %}<br/>
{%- endif %}
</p>

<p>
<a href="https://github.com/okfn/ckan">Source</a>
&mdash;
<a href="https://trac.ckan.org/">Issues</a>
&mdash;
<a href="http://lists.okfn.org/mailman/listinfo/ckan-dev">Mailing List</a>
&mdash;
<a href="http://twitter.com/CKANProject">Twitter @CKANProject</a>
</p>

<p>
Related Projects:
<a href="http://thedatahub.org/">TheDataHub.org</a>
&mdash;
<a href="http://datacatalogs.org">DataCatalogs.org</a>
&mdash;
<a href="http://openspending.org">OpenSpending.org</a>
&mdash;
<a href="http://datapatterns.org">DataPatterns.org</a>
</p>

20 changes: 0 additions & 20 deletions doc/_templates/layout.html

This file was deleted.

1 change: 1 addition & 0 deletions doc/_themes/sphinx-theme-okfn
Submodule sphinx-theme-okfn added at 1e0978
37 changes: 22 additions & 15 deletions doc/conf.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# Comprehensive Knowledge Archive Network (CKAN) documentation build configuration file, created by
# CKAN documentation build configuration file, created by
# sphinx-quickstart on Sun Oct 25 16:47:17 2009.
#
# This file is execfile()d with the current directory set to its containing dir.
Expand Down Expand Up @@ -41,9 +41,9 @@
master_doc = 'index'

# General information about the project.
project = u'CKAN (Comprehensive Knowledge Archive Network)'
project = u'CKAN Data Management System Documentation'
project_short_name = u'CKAN'
copyright = u'2009, Open Knowledge Foundation'
copyright = u'&Copyright copy; 2009-2012, Open Knowledge Foundation'
html_show_sphinx = False

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -94,13 +94,23 @@
# Options for HTML output
# -----------------------

html_theme = 'default'
#html_theme = 'default'
#html_theme_options = {
#"relbarbgcolor": "#777",
#'sidebarbgcolor': '#F2F2F2',
#'sidebartextcolor': 'black',
#'sidebarlinkcolor': '#355F7C',
#'headfont': 'Trebuchet MS'
#}
sys.path.append(os.path.abspath('_themes'))
html_theme_path = ['_themes']
html_theme = 'sphinx-theme-okfn'
html_theme_options = {
"relbarbgcolor": "#777",
'sidebarbgcolor': '#F2F2F2',
'sidebartextcolor': 'black',
'sidebarlinkcolor': '#355F7C',
'headfont': 'Trebuchet MS'
'logo_icon': 'http://assets.okfn.org/p/opendatahandbook/img/data-wrench-inverted.png'
}

html_sidebars = {
'**': ['globaltoc.html']
}

# The style sheet to use for HTML and HTML Help pages. A file of that name
Expand All @@ -110,14 +120,14 @@

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = "%s v%s Administration Guide" % (project, release)
# html_title = "%s v%s Guide" % (project, release)

# A shorter title for the navigation bar. Default is the same as html_title.
html_short_title = "%s Admin Guide" % (project_short_name)
# html_short_title = "%s Admin Guide" % (project_short_name)

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'images/ckan_logo_box.png'
# 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
Expand All @@ -137,9 +147,6 @@
# 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 = {}
Expand Down

0 comments on commit b0885bb

Please sign in to comment.