Merge pull request #25 from peterbe/readthedocs

readthedocs

.circleci/config.yml

@@ -50,3 +50,36 @@ jobs:
             if [ -n "${CIRCLE_TAG}" ]; then
               ./bin/deploy.sh "$CIRCLE_TAG"
             fi
+
+  docs:
+    docker:
+      - image: circleci/python:3.6
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+      - restore_cache:
+          key: deps1-{{ .Branch }}-{{ checksum "docs/requirements.txt" }}
+      - run:
+          command: |
+            python3 -m venv venv
+            . venv/bin/activate
+            pip install -r docs/requirements.txt
+      - save_cache:
+          key: deps1-{{ .Branch }}-{{ checksum "docs/requirements.txt" }}
+          paths:
+            - "venv"
+      - run:
+          command: |
+            . venv/bin/activate
+            cd docs
+            make html
+
+
+workflows:
+  version: 2
+  build_and_docs:
+    jobs:
+      - build
+      - docs

.gitignore

@@ -19,3 +19,4 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+docs/_build/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = DeliveryConsole
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/auth.rst

@@ -0,0 +1,5 @@
+==============
+Authentication
+==============
+
+More to come...

docs/ci.rst

@@ -0,0 +1,12 @@
+======================
+Continuous Integration
+======================
+
+All code is tested with `CircleCI`_. All pull requests runs the
+unit tests and attempts to build.
+
+The `CircleCI`_ is also used to deploy the built code into Dev, Stage and
+Production.
+
+
+.. _`CircleCI`: https://circleci.com/gh/mozilla/delivery-console

docs/conf.py

@@ -0,0 +1,155 @@
+# -*- 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/stable/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 = 'Delivery Console'
+copyright = '2018, Mozilla Product Delivery'
+author = 'Mozilla Product Delivery'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- 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 = [
+]
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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 = 'alabaster'
+
+# 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 = ['_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 = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'DeliveryConsoledoc'
+
+
+# -- 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, 'DeliveryConsole.tex', 'Delivery Console Documentation',
+     'Mozilla Product Delivery', '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, 'deliveryconsole', 'Delivery Console 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, 'DeliveryConsole', 'Delivery Console Documentation',
+     author, 'DeliveryConsole', 'One line description of project.',
+     'Miscellaneous'),
+]

docs/console.rst

@@ -0,0 +1,5 @@
+=======
+Console
+=======
+
+The main app that holds together all the other apps.

docs/contributing.rst

@@ -0,0 +1,7 @@
+============
+Contributing
+============
+
+Be nice and make great things.
+
+See https://github.com/mozilla/delivery-console/issues/9

docs/dev.rst

@@ -0,0 +1,16 @@
+=======================
+Developer Documentation
+=======================
+
+You need your own ``yarn`` and a recent version of NodeJS. To get started
+right away run:
+
+.. code-block:: shell
+
+    $ git clone https://github.com/mozilla/delivery-console.git
+    $ cd delivery-console
+    $ yarn
+    $ yarn start
+
+Now you should be able to open ``http://localhost:3000`` and behold the
+aweomeness.

docs/docs.rst

@@ -0,0 +1,37 @@
+==========================
+Updating The Documentation
+==========================
+
+You need to have Python to build the documentation locally.
+
+The documentation is built in our continuous integration every time
+if you feel bold you can just edit these ``.rst`` files and see if the
+pull request succeeds to build.
+
+To build the documentation, create and activate a Python virtualenv.
+For exampe:
+
+.. code-block:: shell
+
+    $ virtualenv -p `which python3.6` .venv
+    $ source .venv/bin/activate
+
+Now install the Sphinx packages:
+
+.. code-block:: shell
+
+    (.venv) $ pip install -r docs/requirements.txt
+
+Now you should be able to build:
+
+.. code-block:: shell
+
+    (.venv) $ cd docs
+    (.venv) $ make html
+
+Watch out for build errors but if all goes well, you can now open
+the built HTML files in your browser. E.g.:
+
+.. code-block:: shell
+
+    (.venv) $ open _build/html/index.html

docs/index.rst

@@ -0,0 +1,35 @@
+=======================
+Mozilla Delivery Console
+========================
+
+
+One admin interface to rule them all.
+
+Contents
+========
+
+User docs:
+
+.. toctree::
+   :maxdepth: 2
+
+   console
+   normandy
+
+
+Project docs:
+
+.. toctree::
+
+   dev
+   contributing
+   auth
+   ci
+   docs
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/normandy.rst

@@ -0,0 +1,8 @@
+========
+Normandy
+========
+
+Manage your Shield studies through Normandy in this app.
+
+More about how to gain access, rules, teams to talk to, authorization,
+scripting, etc.

docs/requirements.txt

@@ -0,0 +1,2 @@
+Sphinx==1.7.1
+sphinx-rtd-theme==0.2.4