Skip to content

Commit

Permalink
Cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
ahopkins committed Mar 21, 2018
1 parent c1fff94 commit 0b13ef3
Show file tree
Hide file tree
Showing 11 changed files with 128 additions and 215 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,4 @@ docs/_build
.eggs
htmlcov
history
.pytest_cache
3 changes: 3 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@ install:
# command to run tests, e.g. python setup.py test
script:
- python -m pytest test/

env:
- DEVELOPMENT=false
181 changes: 62 additions & 119 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,45 +10,35 @@
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))

# sys.path.insert(0, os.path.abspath('.'))
cwd = os.getcwd()
parent = os.path.dirname(cwd)
sys.path.insert(0, parent)

import merkava

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

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'MerkavaDB'
copyright = u'2017, Adam Hopkins'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
Expand All @@ -57,198 +47,151 @@
version = merkava.__version__
# The full version, including alpha/beta/rc tags.
release = merkava.__version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False


# keep_warnings = False
# -- Options for HTML output ---------------------------------------------------

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

# 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 = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None

# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# 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
# pixels large.
#html_favicon = None

# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True

# html_domain_indices = True
# If false, no index is generated.
#html_use_index = True

# html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False

# html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'merkavadoc'


# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
latex_elements = {}
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

# 'preamble': '',
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'merkava.tex', u'MerkavaDB Documentation',
u'Adam Hopkins', 'manual'),
(
'index',
'merkava.tex',
u'MerkavaDB Documentation',
u'Adam Hopkins',
'manual',
)
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False

# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False

# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []

# latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True


# latex_domain_indices = True
# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'merkava', u'MerkavaDB Documentation',
[u'Adam Hopkins'], 1)
('index', 'merkava', u'MerkavaDB Documentation', [u'Adam Hopkins'], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'merkava', u'MerkavaDB Documentation',
u'Adam Hopkins', 'merkava', 'One line description of project.',
'Miscellaneous'),
(
'index',
'merkava',
u'MerkavaDB Documentation',
u'Adam Hopkins',
'merkava',
'One line description of project.',
'Miscellaneous',
)
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True

# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# texinfo_no_detailmenu = False
7 changes: 1 addition & 6 deletions merkava/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,4 @@

from . import server, channels, views, blueprints

__all__ = [
'server',
'channels',
'views',
'blueprints',
]
__all__ = ['server', 'channels', 'views', 'blueprints']
1 change: 0 additions & 1 deletion merkava/blueprints.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
from sanic import Blueprint
from merkava import views


bp = Blueprint('channels', url_prefix='/v1/<channel>')
bp.add_route(views.ChannelView.as_view(), '/<id:[0-9]*>')
bp.add_route(views.RecentChannelView.as_view(), '/recent/<num:[0-9]*>')

0 comments on commit 0b13ef3

Please sign in to comment.