diff --git a/chronograph/__init__.py b/chronograph/__init__.py index 3b93d0b..4802e90 100644 --- a/chronograph/__init__.py +++ b/chronograph/__init__.py @@ -1 +1 @@ -__version__ = "0.0.2" +__version__ = "1.0" diff --git a/docs/_static/nature.css b/docs/_static/nature.css new file mode 100644 index 0000000..00703a0 --- /dev/null +++ b/docs/_static/nature.css @@ -0,0 +1,245 @@ +/* + * nature.css_t + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- nature theme. + * + * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Arial, sans-serif; + font-size: 100%; + background-color: #111; + color: #555; + margin: 0; + padding: 0; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 230px; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.document { + background-color: #eee; +} + +div.body { + background-color: #ffffff; + color: #3E4349; + padding: 0 30px 30px 30px; + font-size: 0.9em; +} + +div.footer { + color: #EEEEAA; + width: 100%; + padding: 13px 0; + text-align: center; + font-size: 75%; +} + +div.footer a { + color: #EEEEAA; + text-decoration: underline; +} + +div.related { + background-color: #115577; + line-height: 32px; + color: #fff; + text-shadow: 0px 1px 0 #444; + font-size: 0.9em; +} + +div.related a { + color: #EEEEAA; +} + +div.sphinxsidebar { + font-size: 0.75em; + line-height: 1.5em; +} + +div.sphinxsidebarwrapper{ + padding: 20px 0; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Arial, sans-serif; + color: #222; + font-size: 1.2em; + font-weight: normal; + margin: 0; + padding: 5px 10px; + background-color: #ddd; + text-shadow: 1px 1px 0 white +} + +div.sphinxsidebar h4{ + font-size: 1.1em; +} + +div.sphinxsidebar h3 a { + color: #444; +} + + +div.sphinxsidebar p { + color: #888; + padding: 5px 20px; +} + +div.sphinxsidebar p.topless { +} + +div.sphinxsidebar ul { + margin: 10px 20px; + padding: 0; + color: #000; +} + +div.sphinxsidebar a { + color: #444; +} + +div.sphinxsidebar input { + border: 1px solid #ccc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar input[type=text]{ + margin-left: 20px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #005B81; + text-decoration: none; +} + +a:hover { + color: #E32E00; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Arial, sans-serif; + background-color: #115577; + font-weight: normal; + color: #EEEEAA; + margin: 30px 0px 10px 0px; + padding: 5px 0 5px 10px; + text-shadow: 0px 1px 0 black +} + +div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; } +div.body h2 { font-size: 150%; background-color: #115577; } +div.body h3 { font-size: 120%; background-color: #115577; } +div.body h4 { font-size: 110%; background-color: #115577; } +div.body h5 { font-size: 100%; background-color: #115577; } +div.body h6 { font-size: 100%; background-color: #115577; } + +a.headerlink { + color: #c60f0f; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + background-color: #c60f0f; + color: white; +} + +div.body p, div.body dd, div.body li { + line-height: 1.5em; +} + +div.admonition p.admonition-title + p { + display: inline; +} + +div.highlight{ + background-color: white; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +div.topic { + background-color: #eee; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre { + padding: 10px; + background-color: White; + color: #222; + line-height: 1.2em; + border: 1px solid #C6C9CB; + font-size: 1.1em; + margin: 1.5em 0 1.5em 0; + -webkit-box-shadow: 1px 1px 1px #d8d8d8; + -moz-box-shadow: 1px 1px 1px #d8d8d8; +} + +tt { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ + font-size: 1.1em; + font-family: monospace; +} + +.viewcode-back { + font-family: Arial, sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index ca38954..792791e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,7 +12,7 @@ # serve to show the default. import sys, os -from pythonbase import __version__ +from chronograph import __version__ # 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 @@ -42,7 +42,7 @@ master_doc = 'index' # General information about the project. -project = u'pythonbase' +project = u'Chronograph' copyright = u'2015, Anubhav Jain' # The version info for the project you're documenting, acts as replacement for @@ -229,8 +229,8 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'pythonbase', u'Pythonbase Documentation', - u'Anubhav Jain', 'skeleton for creating Python projects', + ('index', 'Chronograph', u'Pythonbase Documentation', + u'Anubhav Jain', 'timing and stopwatch utility', 'Miscellaneous'), ] @@ -247,7 +247,7 @@ # -- Options for Epub output --------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = u'pythonbase' +epub_title = u'Chronograph' epub_author = u'Anubhav Jain' epub_publisher = u'Anubhav Jain' epub_copyright = u'2015, Anubhav Jain' diff --git a/docs/index.rst b/docs/index.rst index b602726..20f251f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,27 @@ Chronograph is a feature-packed timer/stopwatch/chronometer that makes it simple * cast to float gives total time * unit tested +See below for usage examples. + +Installation +============ + +You can install via pip:: + + pip install Chronograph + +or easy_install:: + + pip install Chronograph + +or Github:: + + git clone git@github.com:computron/chronograph.git + cd chronograph + python setup.py install + +The Github page also contains the source code. + Ten Examples of How to Use Chronograph ======================================