Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
gmr committed Sep 26, 2016
1 parent 47d5e4e commit e392930
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 32 deletions.
2 changes: 1 addition & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
API Documentation
=================

.. autoclass:: sprockets_dynamodb.DynamoDB
.. autoclass:: sprockets_dynamodb.Client
:members:
51 changes: 20 additions & 31 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,44 +1,33 @@
# -*- coding: utf-8 -*-
import alabaster
import sys
sys.path.insert(0, '../')
import sprockets_dynamodb

project = 'sprockets.clients.dynamodb'
copyright = 'AWeber Communications, Inc.'
version = sprockets_dynamodb.__version__
release = '.'.join(str(v) for v in sprockets_dynamodb.version_info[0:2])

needs_sphinx = '1.0'
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'sphinx.ext.viewcode'
]

templates_path = []
templates_path = ['_templates']
source_suffix = '.rst'
source_encoding = 'utf-8-sig'
master_doc = 'index'
exclude_patterns = []
pygments_style = 'sphinx'
html_theme = 'alabaster'
html_style = 'custom.css'
html_static_path = ['static']
html_theme_path = [alabaster.get_path()]
html_sidebars = {
'**': ['about.html', 'navigation.html'],
}
html_theme_options = {
'github_user': 'sprockets',
'github_repo': 'sprockets_dynamodb',
'description': 'Amazon DynamoDB Connector',
'github_banner': True,
'travis_button': True,
'codecov_button': True,
'sidebar_width': '230px',
}

project = u'sprockets-dynamodb'
copyright = u'2016, AWeber Communications'
author = u'AWeber Communications'

release = sprockets_dynamodb.__version__
version = '.'.join(release.split('.')[0:1])

language = None
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
pygments_style = 'sphinx'
todo_include_todos = False
html_static_path = ['_static']
htmlhelp_basename = 'sprockets-dynamodbdoc'
intersphinx_mapping = {
'python': ('http://docs.python.org/3/', None),
'tornado': ('http://tornadoweb.org/en/latest/', None),
'tornadoaws': ('https://tornado-aws.readthedocs.org/en/latest/', None),
'python': ('https://docs.python.org/3.5', None),
'tornado_aws': ('https://tornado-aws.readthedocs.io/en/stable/', None),
'tornado': ('https://tornado.readthedocs.io/en/stable/', None)
}

0 comments on commit e392930

Please sign in to comment.