Merge pull request #69 from aninternetof/development

Release 0.4.0

Author: hbradio

.gitignore

@@ -23,6 +23,11 @@ sftp-config.json
 *.py[cod]
 __pycache__
 
+# Docs
+docs/_build
+docs/_autosummary
+docs/generated
+
 # Logs
 logs
 *.log

README.rst

@@ -10,7 +10,7 @@ rovercode-web
 .. image:: https://img.shields.io/badge/chat-on%20Slack-41AB8C.svg?style=flat
       :target: http://chat.rovercode.com/
 .. image:: https://img.shields.io/badge/join-mailing%20list-yellow.svg?style=flat
-      :target: http://rovercode.org/cgi-bin/mailman/listinfo/developers
+      :target: https://1988.onlinegroups.net/groups/rovercode-developers/
 .. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg
       :target: https://github.com/pydanny/cookiecutter-django/
       :alt: Built with Cookiecutter Django
@@ -47,3 +47,18 @@ rovercode-web runs is built with Django. During development, you can do regular
 If anything gives you trouble, see the detailed `cookiecutter-django Docker documentation`_.
 
 .. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html
+
+Docs
+-----
+Read the complete docs `here <http://rovercode-web.readthedocs.io/en/latest/>`_.
+
+Contact
+--------
+Please join the rovercode developer mailing list! `Go here
+<https://1988.onlinegroups.net/groups/rovercode-developers/>`_, then
+click "register".
+
+Also, we'd love to chat with you! Join the `the rovercode Slack channel
+<http://chat.rovercode.com>`_.
+
+You can also email [email protected].

compose/nginx/Dockerfile

@@ -1,9 +1,8 @@
-FROM nginx:latest
+FROM nginx:1.11.10
 ADD nginx.conf /etc/nginx/nginx.conf
 
 
 ADD start.sh /start.sh
 ADD nginx-secure.conf /etc/nginx/nginx-secure.conf
 ADD dhparams.pem /etc/ssl/private/dhparams.pem
 CMD /start.sh
-

config/settings/local.py

@@ -18,6 +18,7 @@
 # ------------------------------------------------------------------------------
 DEBUG = env.bool('DJANGO_DEBUG', default=True)
 TEMPLATES[0]['OPTIONS']['debug'] = DEBUG
+ALLOWED_HOSTS = ['localhost', '127.0.0.1', '[::1]', 'rovercodeweb']
 
 # SECRET CONFIGURATION
 # ------------------------------------------------------------------------------

docs/code_of_conduct.rst

@@ -0,0 +1,76 @@
+Contributor Covenant Code of Conduct
+=====================================
+
+Our Pledge
+###########
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+Our Standards
+##############
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+Our Responsibilities
+#####################
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+Scope
+######
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+Enforcement
+############
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+Attribution
+############
+
+This Code of Conduct is adapted from the `Contributor Covenant <http://contributor-covenant.org/>`_, version 1.4,
+available at `<http://contributor-covenant.org/version/1/4>`_

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Rovercode Web documentation build configuration file, created by
+# rovercode-web documentation build configuration file, created by
 # sphinx-quickstart.
 #
 # This file is execfile()d with the current directory set to its containing dir.
@@ -16,19 +16,35 @@
 import os
 import sys
 
+import django
+sys.path.insert(0, os.path.abspath('..'))
+os.environ['DJANGO_SETTINGS_MODULE'] = 'config.settings.local'
+django.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.
 # sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration -----------------------------------------------------
-
+autoclass_content = "both"  # include both class docstring and __init__
+autodoc_default_flags = [
+    # Make sure that any autodoc declarations show the right members
+    "members",
+    "inherited-members",
+    "private-members",
+    "show-inheritance",
+]
+autosummary_generate = True
 # 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 = []
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -43,17 +59,17 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'Rovercode Web'
-copyright = """2017, rovercode.com"""
+project = 'rovercode-web'
+copyright = """2017, Brady L. Hurlburt and other rovercode.com contributors"""
 
 # 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.
 #
 # The short X.Y version.
-version = '0.1'
+version = '0.4'
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = '0.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -94,7 +110,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+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
@@ -188,7 +204,7 @@
 latex_documents = [
     ('index',
      'rovercode_web.tex',
-     'Rovercode Web Documentation',
+     'rovercode-web Documentation',
      """rovercode.com""", 'manual'),
 ]
 
@@ -218,7 +234,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'rovercode_web', 'Rovercode Web Documentation',
+    ('index', 'rovercode_web', 'rovercode-web Documentation',
      ["""rovercode.com"""], 1)
 ]
 
@@ -232,8 +248,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'rovercode_web', 'Rovercode Web Documentation',
-     """rovercode.com""", 'Rovercode Web',
+    ('index', 'rovercode_web', 'rovercode-web Documentation',
+     """rovercode.com""", 'rovercode-web',
      """Block-based programming for educational robots.""", 'Miscellaneous'),
 ]
 

docs/contribute.rst

@@ -0,0 +1,17 @@
+contribute
+===========
+
+There is lots of fun work to be done!
+
+Head on over to `the rovercode-web github <https://github.com/aninternetof/rovercode-web>`_.
+We use ZenHub to improve GitHub's agile management, so `install it <https://www.zenhub.com/>`_,
+then visit the `boards` tab to find a fun card in the backlog. Or `submit a new
+card <https://github.com/aninternetof/rovercode-web/issues/new>`_ for a bug or cool
+new feature idea.
+
+And remember, you can do all these same things for
+`rovercode <https://github.com/aninternetof/rovercode>`_.
+
+Chat with us on `the rovercode Slack channel <http://chat.rovercode.com>`_.
+
+Follow the `the code of conduct <code_of_conduct.html>`_.