ci(travis): update deployment

changed semantic release to npm package

added automated documentation

.releaserc.json

@@ -0,0 +1,10 @@
+{
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/github",
+        ["@semantic-release/exec", {
+            "publishCmd": "bash deploy.sh ${nextRelease.version}"
+        }]
+    ]
+}

.travis.yml

@@ -17,12 +17,24 @@ after_success:
 
 jobs:
   include:
-    - stage: deploy
-      if: branch = master AND (NOT type IN (pull_request))
-      python: "3.6"
-      env: TRAVIS=true
-      script:
-        - git config --global user.name "ladybugbot"
-        - git config --global user.email "release@ladybug.tools"
-        - pip install python-semantic-release
-        - semantic-release publish
+  - stage: deploy
+    if: branch = master AND (NOT type IN (pull_request))
+    before_install:
+    - npm i -g npm@6.6.0
+    python:
+    - "3.6"
+    install:
+    - pip install -r dev-requirements.txt
+    - npm install @semantic-release/exec
+    script:
+    - git config --global user.email "releases@ladybug.tools"
+    - git config --global user.name "ladybugbot"
+    - npx semantic-release
+    deploy:
+      provider: pages
+      skip_cleanup: true
+      github-token: $GH_TOKEN
+      keep-history: false
+      local_dir: docs/_build/
+      on:
+        branch: master

Dockerfile

@@ -4,4 +4,4 @@ MAINTAINER Ladybug Tools "info@ladybug.tools"
 WORKDIR /usr/local/lib/python2.7/site-packages
 
 # copy ladybug
-COPY ./ladybug ./ladybug
+COPY ./ladybug_geometry ./ladybug_geometry

deploy.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+deploy_to_pypi() {
+  echo "Building distribution"
+  python setup.py sdist bdist_wheel
+  echo "Pushing new version to PyPi"
+  twine upload dist/* -u $PYPI_USERNAME -p $PYPI_PASSWORD 
+}
+
+build_docs() {
+  echo "Building documentation files"
+  sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug-geometry
+  sphinx-build -b html ./docs ./docs/_build/docs -D release=$1 -D version=$1
+}
+
+
+if [ -n "$1" ]
+then
+  NEXT_RELEASE_VERSION=$1
+else
+  echo "A release version must be supplied"
+  exit 1
+fi
+
+deploy_to_pypi
+build_docs $NEXT_RELEASE_VERSION

dev-requirements.txt

@@ -2,3 +2,8 @@ coverage==4.5.3
 coveralls==1.7.0
 pytest==4.3.1
 pytest-cov==2.6.1
+Sphinx==1.8.5
+sphinx-bootstrap-theme==0.6.5
+sphinxcontrib-fulltoc==1.2.0
+sphinxcontrib-websupport==1.1.0
+twine==1.13.0

docs/README.md

@@ -0,0 +1,13 @@
+
+## Usage
+For generating the documents locally use commands below from the root folder. 
+
+```shell
+# install dependencies
+pip install Sphinx sphinxcontrib-fulltoc sphinx_bootstrap_theme
+
+# generate rst files for modules
+sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_geometry
+# build the documentation under _build/docs folder
+sphinx-build -b html ./docs ./docs/_build/docs
+```

docs/_build/.nojekyll

@@ -0,0 +1 @@
+

docs/_build/README.md

@@ -0,0 +1 @@
+# documentation

docs/_build/docs/README.md

@@ -0,0 +1 @@
+# documentation

docs/conf.py

@@ -0,0 +1,214 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'ladybug geometry'
+copyright = '2019, Ladybug Tools'
+author = 'Ladybug Tools'
+
+# The full version, including alpha/beta/rc tags
+release = ''
+
+# for example take major/minor
+version = ''
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# 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.doctest',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.imgmath',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+	'sphinxcontrib.fulltoc',
+	'sphinx.ext.napoleon'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+import sphinx_bootstrap_theme
+
+# html_theme = 'alabaster'
+html_theme = 'bootstrap'
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+
+# 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 = {
+    # For black navbar, do "navbar navbar-inverse"
+    'navbar_class': "navbar navbar-inverse",
+    # Fix navigation bar to top of page?
+    # Values: "true" (default) or "false"
+    'navbar_fixed_top': "true",
+	'navbar_pagenav': True,
+    'source_link_position': "nav",
+	'bootswatch_theme': "united",
+    'bootstrap_version': "3",
+	}
+
+# on_rtd is whether we are on readthedocs.org
+# on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# if not on_rtd:  # only import and set the theme if we're building docs locally
+#    import sphinx_rtd_theme
+#    html_theme = 'sphinx_rtd_theme'
+#    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+html_sidebars = {
+    '**': ['localtoc.html']
+}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ladybuggeodoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'ladybug geometry.tex', 'ladybug geometry Documentation',
+     'Ladybug Tools', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'ladybug geometry', 'ladybug geometry Documentation',
+     [author], 1)
+]
+
+
+# -- 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 = [
+    (master_doc, 'ladybug geometry', 'ladybug geometry Documentation',
+     author, 'ladybug geometry', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

docs/index.rst

@@ -0,0 +1,21 @@
+.. Ladybug Geometry documentation master file, created by
+   sphinx-quickstart on Wed Mar 13 20:09:41 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Ladybug Geometry's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. include:: modules.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/modules.rst

@@ -0,0 +1,7 @@
+ladybug-geometry
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   ladybug-geometry