Add a documentation project

This adds a documentation project which, at the moment, just contains
the migration plan.

Signed-off-by: Jeremy Cline <jeremy@jcline.org>

dev-requirements.txt

@@ -0,0 +1 @@
+sphinx

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    = FedmsgMigrationTools
+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/conf.py

@@ -0,0 +1,180 @@
+# -*- 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 = 'Fedmsg Migration Tools'
+copyright = '2018, Red Hat, Inc'
+author = 'Jeremy Cline, Aurélien Bompard'
+
+# The short X.Y version
+version = '0.1'
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- 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.intersphinx',
+    'sphinx.ext.viewcode',
+    '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 = ['_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 = {
+    'github_user': 'jeremycline',
+    'github_repo': 'fedmsg-migration-tools',
+    'page_width': '1040px',
+}
+
+# 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 = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'FedmsgMigrationToolsdoc'
+
+
+# -- 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, 'FedmsgMigrationTools.tex', 'Fedmsg Migration Tools Documentation',
+     'Jeremy Cline', '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, 'fedmsgmigrationtools', 'Fedmsg Migration Tools 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, 'FedmsgMigrationTools', 'Fedmsg Migration Tools Documentation',
+     author, 'FedmsgMigrationTools', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+}

docs/index.rst

@@ -0,0 +1,19 @@
+.. Fedmsg Migration Tools documentation master file, created by
+   sphinx-quickstart on Wed Apr 25 16:12:45 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+======================
+Fedmsg Migration Tools
+======================
+
+A set of tools to assist in Fedora's migration from fedmsg to an broker-based
+message system.
+
+Migration Documentation
+=======================
+
+.. toctree::
+   :maxdepth: 2
+
+   migration/overview

docs/migration/Fedora_AMQP_migration.xml

@@ -0,0 +1 @@
+<mxfile userAgent="Mozilla/5.0 (X11; Fedora; Linux x86_64; rv:58.0) Gecko/20100101 Firefox/58.0" version="8.5.12" editor="www.draw.io" type="device"><diagram id="0acbb2b3-cbe4-0ef9-e633-b75d80445cfc" name="Page-1">1VhNc5swEP01XDOAwOBjk7rtIZ5J6kOb3gTIoBYQlYUN+fUVSIBBdpxxsXF8sbSrz6f3Vos08JAUXynMoiUJUKyZelBo4LNmmoZh6PyvspTCYoO5MIQUB7JRZ1jhVySNsl+Y4wBteg0ZITHDWd/okzRFPuvZIKVk12+2JnF/1gyGSDGsfBir1h84YJGwuqbT2b8hHEZyZtsFwuFB/09ISZ7K6TQTrOufcCewGUrucxPBgOz25gQLDTxQQpgoJcUDiitoG9REvy9HvO2yKUrZezrMRIctjHO58+/Q8zBbPmvmLOZD3HuUl8KqdK6l3icrG2hrdFA1v8HduwgztMqgX3l3nEzcFrEklm51P3KLW0QZKobAcT4ikiBGS95EeoFlii6Sii32u+5gjblsE+0daktiKMkUtmN3iPKCBPXIiQAFABRwqskqoSwiIUlhvOis9x1Eeh8OVGD2szLf2bL20nhSvrA9V1V9kQP8RoyVUmMwZ4SbunkfCclOgb0hOfXl6iVQDNIQyVZS2tW+3jwQimLI8LYvsf8Bt1nMyODuQbuHZutqoa19lwbXmgxcJTT8qqKCnuVejDcRogr2J7QMN5kI1WtcVPiPIW5j7vTEDVRtuwek7Y6g7Pb8LqzsUQkGVIK5UxEMKAT7tHx+ujWGWYPr44oMs44okCc9mzy5DXiGArTs6+FjHyPQLQEEJgTImH/AEOWoIcqeKkQ5CsNek793jGTYV5DlqXxWFf0yxhxAejq59QTSj96Y2a49yHYdlW7OAbrZ9gh0sy9BN0MbpmOj0s1V6dbk/RPkXPolEDxfsG99VZyL7uhill2fCOYLaYVgG30hWNYgoIo1yV6DI2qX8T7eWx+Q93P1ZJypaD9XwqxIdPgWTV3c6RM/IrSfQ2UT6tSweugNYTbGLe5eJyhc7Qmhia838ZnbLEbNImv21UScmHz24E4H1vXI5yrowBvPgCyrn3BfMAPi1e6pVlwc3XM4WPwD</diagram></mxfile>