Skip to content

Commit

Permalink
Use alabaster sphinx schema
Browse files Browse the repository at this point in the history
  • Loading branch information
asvetlov committed Jan 4, 2015
1 parent 1cc06f9 commit 8e7a193
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 6 deletions.
Binary file added docs/_static/aiohttp-icon-128x128.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/aiohttp-icon-32x32.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/aiohttp-icon-64x64.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/aiohttp-icon-96x96.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 22 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('..'))

import alabaster

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
Expand All @@ -49,7 +51,8 @@
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx'
'sphinx.ext.intersphinx',
'alabaster',
]

intersphinx_mapping = {'python': ('http://docs.python.org/3', None)}
Expand Down Expand Up @@ -122,15 +125,24 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'alabaster'

# 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 = {
'logo': 'aiohttp-icon-96x96.png',
'logo_name': True,
'logo_text_align': 'center',
'github_user': 'KeepSafe',
'github_repo': 'aiohttp',
'github_button': True,
'github_banner': True,
'travis_button': True,
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
html_theme_path = [alabaster.get_path()]

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand All @@ -141,7 +153,7 @@

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'aiohttp-icon.svg'
# html_logo = 'aiohttp-icon.svg'

# 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 @@ -167,7 +179,11 @@
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
html_sidebars = {
'**': [
'about.html', 'navigation.html', 'searchbox.html',
]
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down
1 change: 1 addition & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
flake8
nose
coverage
alabaster>=0.6.2

0 comments on commit 8e7a193

Please sign in to comment.