Documentation updates

.github/workflows/docs.yml

@@ -0,0 +1,23 @@
+name: Publish Documentation
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    name: Publish Documentation
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: Install ghp-import
+        run: pip install ghp-import
+      - name: Build documentation
+        run: "./pants docs ::"
+      - name: Publish Documentation
+        run: ghp-import --push --force --no-history --no-jekyll dist/sphinx/

.gitignore

@@ -111,3 +111,9 @@ webpack-stats.json
 
 # Celery Beat
 celerybeat-schedule
+
+# pants
+/.pants.d/
+/dist/
+/.pids
+/.pants.workdir.file_lock*

docs/BUILD

@@ -0,0 +1,6 @@
+
+
+sphinx_docs(
+    name="sphinx-docs",
+    source_directory="source"
+)

docs/source/assets/authentication-flow.mm

@@ -0,0 +1,25 @@
+sequenceDiagram
+    participant MO as MITx Online
+    participant OE as Open edX
+
+    par Create Account in Open edx
+        MO->>OE: POST /user_api/v1/account/registration/
+        OE-->>MO: Success
+    end
+
+    par Create Open edX Access Token
+        Note right of MO: Create in-memory requests session
+        par Establish an Open edX session
+            MO->>OE: GET /auth/login/mitxpro-oauth2/?auth_entry=login
+            OE->>MO: Redirect to GET /oauth2/authorize
+            MO->>OE: Redirect to GET /auth/complete/mitxpro-oauth2/
+        end
+
+        par Link MITx Online account to Open edX Account
+            MO->>OE: GET /oauth2/authorize
+            OE-->>MO: Redirect to GET /login/_private/complete
+            MO->>OE: POST /oauth2/access_token
+            OE-->>MO: OAuth access and refresh tokens
+        end
+
+    end

docs/source/authentication.rst

@@ -0,0 +1,4 @@
+Authentication
+==============
+
+.. mermaid:: assets/authentication-flow.mm

docs/source/conf.py

@@ -0,0 +1,54 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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 = 'MITx Online'
+copyright = '2021, OL Engineering'
+author = 'OL Engineering'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinxcontrib.mermaid',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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 = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_permalinks_icon = '§'
+html_theme = 'insipid'
+
+# 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']

docs/source/configuration/index.rst

@@ -0,0 +1,7 @@
+Configuration
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   open_edx