Doc WIP

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Cilium
+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)

doc/conf.py

@@ -0,0 +1,157 @@
+# -*- coding: utf-8 -*-
+#
+# Cilium documentation build configuration file, created by
+# sphinx-quickstart on Sun Feb 12 18:34:43 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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('.'))
+
+
+# -- 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.ifconfig',
+    'sphinx.ext.githubpages']
+
+# 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'
+
+# General information about the project.
+project = u'Cilium'
+copyright = u'2017, Cilium Authors'
+author = u'Cilium Authors'
+
+# 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 = u'v1alpha'
+# The full version, including alpha/beta/rc tags.
+release = u'v1alpha'
+
+# 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 patterns also effect to 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'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Ciliumdoc'
+
+
+# -- 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, 'Cilium.tex', u'Cilium Documentation',
+     u'Cilium Authors', '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, 'cilium', u'Cilium 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, 'Cilium', u'Cilium Documentation',
+     author, 'Cilium', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

doc/contributing.md → doc/contributing.rst

@@ -1,63 +1,75 @@
-# Contributing
+Contributing
+============
 
-If you wish to contribute to the Cilium project, feel encouraged to do so.
+.. contents::
+
+If you wish to contribute to the Cilium project, feel encouraged to do
+so.
+
+Setting up the a development enviroment
+---------------------------------------
+
+Submitting a pull request
+-------------------------
 
 Contributions may be submitted in the form of pull requests against the
 github repository at: [https://github.com/cilium/cilium]
 
 Before hitting the submit button, please make sure that the following
-requirements have been met:
-  * The pull request and all corresponding commits have been equipped with
-    a well written commit message which explains the reasoning and details
-    of the change.
-  * You have added unit and/or runtime tests where feasible.
-  * You have tested the changes and checked for regressions by running the
-    existing testsuite against your changes. See the "Testsuite" section for
-    additional details.
-  * You have signed off on your commits, see the section
-    "Developer's Certificate of Origin" for more details.
+requirements have been met: \* The pull request and all corresponding
+commits have been equipped with a well written commit message which
+explains the reasoning and details of the change. \* You have added unit
+and/or runtime tests where feasible. \* You have tested the changes and
+checked for regressions by running the existing testsuite against your
+changes. See the "Testsuite" section for additional details. \* You have
+signed off on your commits, see the section "Developer's Certificate of
+Origin" for more details.
 
+Developer's Certificate of Origin
+---------------------------------
 
-## Developer's Certificate of Origin
+To improve tracking of who did what, we've introduced a "sign-off"
+procedure.
 
-To improve tracking of who did what, we've introduced a "sign-off" procedure.
+The sign-off is a simple line at the end of the explanation for the
+commit, which certifies that you wrote it or otherwise have the right to
+pass it on as open-source work. The rules are pretty simple: if you can
+certify the below:
 
-The sign-off is a simple line at the end of the explanation for the commit,
-which certifies that you wrote it or otherwise have the right to pass it on
-as open-source work.  The rules are pretty simple: if you can certify the below:
+::
 
     Developer Certificate of Origin
     Version 1.1
-    
+
     Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
     1 Letterman Drive
     Suite D4700
     San Francisco, CA, 94129
-    
+
     Everyone is permitted to copy and distribute verbatim copies of this
     license document, but changing it is not allowed.
-    
-    
+
+
     Developer's Certificate of Origin 1.1
-    
+
     By making a contribution to this project, I certify that:
-    
+
     (a) The contribution was created in whole or in part by me and I
         have the right to submit it under the open source license
         indicated in the file; or
-    
+
     (b) The contribution is based upon previous work that, to the best
         of my knowledge, is covered under an appropriate open source
         license and I have the right under that license to submit that
         work with modifications, whether created in whole or in part
         by me, under the same open source license (unless I am
         permitted to submit under a different license), as indicated
         in the file; or
-    
+
     (c) The contribution was provided directly to me by some other
         person who certified (a), (b) or (c) and I have not modified
         it.
-    
+
     (d) I understand and agree that this project and the contribution
         are public and that a record of the contribution (including all
         personal information I submit with it, including my sign-off) is
@@ -66,21 +78,19 @@ as open-source work.  The rules are pretty simple: if you can certify the below:
 
 then you just add a line saying::
 
+::
+
     Signed-off-by: Random J Developer <random@developer.example.org>
 
 using your real name (sorry, no pseudonyms or anonymous contributions.)
 
-## Testsuite
+Testsuite
+---------
 
 The testsuite can be run on a vagrant box:
 
-   ```
-   $ vagrant provision --provision-with testsuite
-   ```
+``$ vagrant provision --provision-with testsuite``
 
 or manually on the local machine:
 
-   ```
-   $ sudo make runtime-tests
-   ```
-
+``$ sudo make runtime-tests``