Initial docs

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.7
+
+WORKDIR /usr/src/mds
+
+COPY . .
+
+RUN apt-get update -y && \
+    pip install --upgrade pip && \
+    pip install pipenv && \
+    pipenv update --dev

Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = ./docs
+BUILDDIR      = ./docs/_build
+
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)

Pipfile

@@ -0,0 +1,14 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[dev-packages]
+mds-provider = {path = ".", editable = true}
+recommonmark = "*"
+requests = "*"
+sphinx = "*"
+sphinx-rtd-theme = "*"
+
+[requires]
+python_version = "3.7"

README.md

@@ -1,8 +1,8 @@
-# mds-provider
+# mds-provider [![Documentation Status][docs-status]][docs]
 
 Tools for working with [MDS `provider`][provider] data.
 
-Developed and tested with Python 3.7+.
+Developed and tested with Python 3.6.
 
 See [`mds-provider-services`](https://github.com/CityofSantaMonica/mds-provider-services) for real-world usage of many of these tools.
 
@@ -72,7 +72,31 @@ db.load_trips(trips)
 | [`mds.schemas`](mds/schemas.py) | Validate data using the [JSON schemas][schemas] |
 | [`mds.versions`](mds/versions.py) | Work with [MDS versions][versions] |
 
+## Generating documentation
+
+`mds-provider` uses [Sphinx][sphinx] for documentation generation. We provide a minimal Docker setup for building and
+serving documentation locally:
+
+```bash
+docker-compose run [--rm] docs
+```
+
+After the first-time image build, and subsequent Sphinx build(s), view the docs at http://localhost:8000
+
+To rebuild after a code change, run the command again:
+
+```bash
+docker-compose run [--rm] docs
+```
+
+To bring down the local server:
+
+```bash
+docker-compose down
+```
+
 [provider]: https://github.com/CityOfLosAngeles/mobility-data-specification/tree/master/provider
 [registry]: https://github.com/CityofLosAngeles/mobility-data-specification/blob/master/providers.csv
 [schemas]: https://github.com/CityOfLosAngeles/mobility-data-specification/tree/master/generate_schema
+[sphinx]: http://www.sphinx-doc.org/en/stable/
 [versions]: https://github.com/CityofLosAngeles/mobility-data-specification/releases

docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3.7"
+services:
+  docs:
+    build: .
+    working_dir: /usr/src/mds
+    depends_on:
+      - nginx
+    command: pipenv run make html
+    volumes:
+      - .:/usr/src/mds
+  nginx:
+    image: nginx:latest
+    ports:
+      - 8000:80
+    volumes:
+      - ./docs/_build/html:/usr/share/nginx/html

docs/conf.py

@@ -0,0 +1,193 @@
+# -*- 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(1, os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'mds-provider'
+copyright = '2018, City of Santa Monica'
+author = 'City of Santa Monica'
+
+import mds.versions
+# The short X.Y version
+version = mds.Version.library().header
+# The full version, including alpha/beta/rc tags
+release = str(mds.Version.library())
+
+
+# -- 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.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = []
+
+source_parsers = {
+   '.md': 'recommonmark.parser.CommonMarkParser',
+}
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = ['.rst', '.md']
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store', 'Makefile', 'conf.py']
+
+# 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.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# 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 = {}
+
+# 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 = []
+
+# 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 = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'mds-provider-doc'
+
+
+# -- 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, 'mds-provider.tex', 'mds-provider Documentation',
+     'City of Santa Monica', '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, 'mds-provider', 'mds-provider 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, 'mds-provider', 'mds-provider Documentation',
+     author, 'mds-provider', 'Python tools for working with Mobility Data Specification: Provider data.',
+     '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/examples/fake-data.md

@@ -0,0 +1,30 @@
+# Generating Fake Data 
+
+To work with MDS data, you may in fact, need to generate fake data for a variety of purposes. 
+
+To facililate that, *MDS Provider* has a `mds.fake` module that assists in the development of fake data. 
+
+## Examples
+
+To generate data, you'll need to setup a `ProviderDataGenerator`. 
+```python 
+from mds.fake.provider import ProviderDataGenerator
+
+
+gen = ProviderDataGenerator(
+        boundary=boundary,
+        speed=speed,
+        vehicle_types=args.vehicle_types,
+        propulsion_types=args.propulsion_types)
+
+```
+
+The above code creates a generator. To use that generator to make trips. The following example generates trips and status changes for 1 day, as definied by the variables. 
+
+```python 
+
+day_status_changes, day_trips = \
+gen.service_day(devices, date, hour_open, hour_closed, inactivity)
+```
+
+There are a number of options to help generate fake data. For example of the options in use, see the [mds-provider-services](https://github.com/CityofSantaMonica/mds-provider-services/blob/master/fake/main.py) repo. 

docs/examples/index.rst

@@ -0,0 +1,10 @@
+Example Usage
+==============================
+
+Python code examples of features in :code:`mds-provider`.
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Sections:
+
+    schema-validation