From 2df461b6cf255e670b1bd10576c920377f212af1 Mon Sep 17 00:00:00 2001
From: Finn <finn@finn.io>
Date: Fri, 12 Feb 2016 10:00:49 -0800
Subject: [PATCH 1/4] Add stuff to transition to sphinx-based rendering

---
 .gitignore       |  60 +++++++++++
 Makefile         | 177 +++++++++++++++++++++++++++++++
 conf.py          | 267 +++++++++++++++++++++++++++++++++++++++++++++++
 requirements.txt |   2 +
 4 files changed, 506 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 Makefile
 create mode 100644 conf.py
 create mode 100644 requirements.txt

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 00000000..445cfeef
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,60 @@
+#### joe made this: http://goel.io/joe
+
+#####=== Python ===#####
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+_build/
diff --git a/Makefile b/Makefile
new file mode 100644
index 00000000..16760e9a
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/HyperboriaDocumentation.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/HyperboriaDocumentation.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/HyperboriaDocumentation"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/HyperboriaDocumentation"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/conf.py b/conf.py
new file mode 100644
index 00000000..ba006358
--- /dev/null
+++ b/conf.py
@@ -0,0 +1,267 @@
+# -*- coding: utf-8 -*-
+#
+# Hyperboria Documentation documentation build configuration file, created by
+# sphinx-quickstart on Fri Feb 12 09:25:49 2016.
+#
+# 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.
+
+import sys
+import os
+from recommonmark.parser import CommonMarkParser
+
+
+# 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 ------------------------------------------------
+
+# 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.todo',
+    'sphinx.ext.pngmath',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+source_parsers = {
+    '.md': CommonMarkParser,
+}
+
+# The suffix of source filenames.
+source_suffix = '.md'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Hyperboria Documentation'
+copyright = u'2016, The Hyperborians'
+
+# 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'
+# The full version, including alpha/beta/rc tags.
+release = '1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = 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 = 'default'
+
+# 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 themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'HyperboriaDocumentationdoc'
+
+
+# -- 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': '',
+}
+
+# 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 = [
+  ('index', 'HyperboriaDocumentation.tex', u'Hyperboria Documentation Documentation',
+   u'The Hyperborians', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'hyperboriadocumentation', u'Hyperboria Documentation Documentation',
+     [u'The Hyperborians'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- 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 = [
+  ('index', 'HyperboriaDocumentation', u'Hyperboria Documentation Documentation',
+   u'The Hyperborians', 'HyperboriaDocumentation', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 00000000..7ac50cbc
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+Sphinx==1.3.5
+recommonmark==0.4.0

From cbe3ad0b65242744f3c0c6dba3a3b377ab47a828 Mon Sep 17 00:00:00 2001
From: Finn <finn@finn.io>
Date: Fri, 12 Feb 2016 12:01:39 -0800
Subject: [PATCH 2/4] Cleaned up conf a bit

---
 conf.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/conf.py b/conf.py
index ba006358..cdff32cb 100644
--- a/conf.py
+++ b/conf.py
@@ -119,7 +119,7 @@
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+html_title = "Hyperboria Documentation"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
@@ -185,7 +185,7 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'HyperboriaDocumentationdoc'
+htmlhelp_basename = 'HyperboriaDocumentation'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -205,7 +205,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'HyperboriaDocumentation.tex', u'Hyperboria Documentation Documentation',
+  ('index', 'HyperboriaDocumentation.tex', u'Hyperboria Documentation',
    u'The Hyperborians', 'manual'),
 ]
 
@@ -235,7 +235,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'hyperboriadocumentation', u'Hyperboria Documentation Documentation',
+    ('index', 'hyperboriadocumentation', u'Hyperboria Documentation',
      [u'The Hyperborians'], 1)
 ]
 
@@ -249,7 +249,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'HyperboriaDocumentation', u'Hyperboria Documentation Documentation',
+  ('index', 'HyperboriaDocumentation', u'Hyperboria Documentation',
    u'The Hyperborians', 'HyperboriaDocumentation', 'One line description of project.',
    'Miscellaneous'),
 ]

From cef830b6852e94c4567f77d659b73cca1f295c00 Mon Sep 17 00:00:00 2001
From: Geoffroy Schmitlin <geoffroy.schmitlin@phiropsi.com>
Date: Sun, 14 Feb 2016 22:15:06 +0100
Subject: [PATCH 3/4] Added a custom sphinx theme based on default. Added menu
 to sidebar. Other small css fixes.

---
 conf.py                          |   5 +-
 css/main.css                     |  23 ------
 hyperboria-theme/layout.html     | 131 +++++++++++++++++++++++++++++++
 hyperboria-theme/static/main.css |  31 ++++++++
 hyperboria-theme/theme.conf      |   3 +
 index.md                         | 124 ++++++++++++++---------------
 6 files changed, 230 insertions(+), 87 deletions(-)
 mode change 100644 => 100755 conf.py
 delete mode 100644 css/main.css
 create mode 100644 hyperboria-theme/layout.html
 create mode 100755 hyperboria-theme/static/main.css
 create mode 100644 hyperboria-theme/theme.conf
 mode change 100644 => 100755 index.md

diff --git a/conf.py b/conf.py
old mode 100644
new mode 100755
index cdff32cb..d3270f03
--- a/conf.py
+++ b/conf.py
@@ -107,7 +107,8 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'hyperboria-theme'
+html_theme_path = ["."]
 
 # 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
@@ -136,7 +137,7 @@
 # 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']
+# html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
diff --git a/css/main.css b/css/main.css
deleted file mode 100644
index 733096a9..00000000
--- a/css/main.css
+++ /dev/null
@@ -1,23 +0,0 @@
-html, body{
-  font-family: Sans-Serif;
-  height: 100%;
-}
-
-h1 {
-  text-decoration: underline;
-}
-
-.content {
-  width: 90%;
-/*
-  height: 100%;
-  min-height: 100%;
-  margin: 0 auto calc(-5% - 8px);
-*/
-}
-/*
-footer {
-  height: 5%;
-  position: fixed;
-}
-*/
diff --git a/hyperboria-theme/layout.html b/hyperboria-theme/layout.html
new file mode 100644
index 00000000..ac7a514c
--- /dev/null
+++ b/hyperboria-theme/layout.html
@@ -0,0 +1,131 @@
+{#
+    hyperboria-theme/layout.html
+    ~~~~~~~~~~~~~~~~~~~
+
+    Sphinx layout template for the default theme.
+
+    :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+
+{%- extends "basic/layout.html" %}
+
+{%- block sidebartoc %}
+            
+            
+            
+    {% set sidebar_menu = [
+        ('title', 'About Hyperboria'),
+            ('Asking Questions *TODO*', 'todo'),
+            ('Peering', 'faq/peering'),
+            ('Security', 'faq/security'),
+            ('Meshlocals', 'meshlocals/intro', 
+                [('Meshlocals around the world', 'meshlocals/existing/index'), 
+                ('Starting a Meshlocal', 'meshlocals/diy')]),
+            ('FAQ', 'faq/general'),
+            ('Achievements', 'achievements'),
+            ('Glossary', 'faq/glossary'),
+            
+        ('title', 'The cjdns routing protocol'),
+            ('About', '', [
+              ('Goals', 'project-goals'), 
+              ('Goals (russian)', 'project-goals-ru'),
+              ('Original whitepaper', 'Whitepaper'),
+              ('Brief intro', 'intro'),
+              ('Security Specification', 'security-specifications'),
+            ]),
+            ('Installation', '', [
+              ('Most Linuxes *TODO*', 'todo'),
+              ('OpenWrt', 'install/openwrt'),
+              ('Android *TODO*', 'todo'),
+              ('Firefox OS *TODO*', 'todo'),
+              ('OS X', 'install/osx'),
+              ('Debian Wheezy', 'install/debian-wheezy'),
+              ('Debian Jessie', 'install/debian-jessie'),
+              ('Arch', 'install/arch'),
+              ('Fedora', 'install/fedora'),
+              ('FreeBSD *TODO*', 'todo'),
+              ('OpenBSD *TODO*', 'todo'),
+              ('Windows', 'install/windows'),
+                ('Building *on* Windows', 'install/build-on-windows'),
+                ('Securing your Windows system', 'config/windows-firewall'),
+            ]),
+            ('Usage', '', [
+              ('Setup', 'config/configure'),
+              ('Operator guidelines', 'cjdns/operator-guidelines'),
+              ('Securing your system', 'config/network-services'),
+              ('Tools *TODO*', 'todo'),
+                ('Third party tools', 'ctrls'),
+              ('Admin API', 'cjdns/admin-api'),
+              ]),
+            ('Working with cjdns', '', [
+              ('Anatomy of cjdroute', 'cjdns/anatomy'),
+              ('Peering over UDP', 'cjdns/peering-over-UDP-IP'),
+              ('nodeinfo.json', 'cjdns/nodeinfo-json'),
+              ('Changelog', 'cjdns/changelog'),
+              ]),
+            ('HowTo', '', [
+              ('Using cjdns as a VPN', 'config/tunnel'),
+              ('Shorewall and VPN gateway', 'config/shorewall-and-vpn-gateway-howto'),
+              ('NAT gateway for non-cjdns nodes', 'config/nat-gateway'),
+              ('Autostart at login', 'config/autostart-at-login'),
+              ('Run as non-root user', 'config/non-root-user'),
+              ]),
+            ('Troubleshooting', '', [
+              ('Read this first', 'bugs/policy'),
+              ('Memory leaks', 'bugs/debugging-memory-leaks'),
+              ('SecComp', 'bugs/Seccomp'),
+              ('Analyzing network IO', 'traffic-analysis'),
+              ]),
+            ('Known issues', '', [
+                ('Horizon', 'bugs/horizon'),
+                ('Black Hole', 'bugs/black-hole'),
+                ('Secret Santa', 'bugs/santa'),
+                ]),
+            ('Configurator timeout', '', [
+                  ('Firewall on localhost', 'bugs/configurator-timeout'),
+                  ('UDP overflow', 'bugs/connectTo-overflow'),
+                  ('Hidden Peers', 'bugs/hidden-peers'),
+            ]),
+            ('OS/distro-specific quirks', 'bugs/distro-quirks'),
+            ('Reporting bugs', 'bugs/reporting')
+            
+            ]%}
+            
+             
+
+            {%- include "localtoc.html" %}
+            <h3><a href="{{ pathto('index') }}">Menu</a></h3>
+            <ul class="sidebar_menu">
+                {% for link in sidebar_menu %}
+                    {% if link[0] == 'title' %}
+                        <h4>{{ link[1] }}</h4>
+                    {% else %}
+                        {% if link[1] == '' %}
+                        <li class="subtitle">{{ link[0] }}</li>
+                        {% elif link[1] == 'todo' %}
+                        <li class='todo'>{{ link[0] }}</li>
+                        {% else %}
+                        <li><a href="{{ pathto(link[1]) }}">{{ link[0] }}</a></li>
+                        {% endif %}
+                        {% if link[2] %}
+                        <ul>
+                           
+                            {% for sublink in link[2] %}
+                                {% if sublink[1] == 'todo' %}
+                                <li class='todo'>{{ sublink[0] }}</li>
+                                {% else %}
+                                <li><a href="{{ pathto(sublink[1]) }}">{{ sublink[0] }}</a></li>
+                                {% endif %}
+                            {% endfor %}
+                        </ul>
+                        {% endif %}
+                        
+                    {% endif %}
+                {% endfor %}
+            </ul>
+            
+                
+
+{%- endblock %}
+
diff --git a/hyperboria-theme/static/main.css b/hyperboria-theme/static/main.css
new file mode 100755
index 00000000..b167c7cf
--- /dev/null
+++ b/hyperboria-theme/static/main.css
@@ -0,0 +1,31 @@
+@import url("default.css");
+
+
+html, body{
+    font-family: Helvetica-neue, Sans-Serif;
+    height: 100%;
+}
+
+.body {
+    min-height: 1500px;
+}
+
+
+.document .sphinxsidebar li {
+    text-overflow: ellipsis;
+    list-style-position:inside;
+    overflow: hidden;
+}
+
+.document .sphinxsidebar ul {
+    margin-right: 0;
+}
+
+.todo {
+    color: #ccc;
+}
+
+.content {
+  width: 90%;
+}
+
diff --git a/hyperboria-theme/theme.conf b/hyperboria-theme/theme.conf
new file mode 100644
index 00000000..e4373da7
--- /dev/null
+++ b/hyperboria-theme/theme.conf
@@ -0,0 +1,3 @@
+[theme]
+inherit = default
+stylesheet = main.css
\ No newline at end of file
diff --git a/index.md b/index.md
old mode 100644
new mode 100755
index f77014d6..654d5409
--- a/index.md
+++ b/index.md
@@ -17,86 +17,86 @@ You can contribute to its documentaion: https://github.com/hyperboria/docs
 
 ## About Hyperboria
 
-- [Asking Questions](wtfm.md) *TODO*
-- [Peering](faq/peering.md)
-- [Security](faq/security.md)
-- [Meshlocals](meshlocals/intro.md)
-  - [Meshlocals around the world](meshlocals/existing/index.md)
-  - [Starting a Meshlocal](meshlocals/diy.md)
-- [FAQ](faq/general.md)
-- [Achievements](achievements.md)
-- [Glossary](faq/glossary.md)
+- [Asking Questions](wtfm.html) *TODO*
+- [Peering](faq/peering.html)
+- [Security](faq/security.html)
+- [Meshlocals](meshlocals/intro.html)
+  - [Meshlocals around the world](meshlocals/existing/index.html)
+  - [Starting a Meshlocal](meshlocals/diy.html)
+- [FAQ](faq/general.html)
+- [Achievements](achievements.html)
+- [Glossary](faq/glossary.html)
 
 
 ## The cjdns routing protocol
 
 - About
-  - [Goals](project-goals.md) ([russian](project-goals-ru.md))
-  - [Original whitepaper](Whitepaper.md)
-  - [Brief intro](intro.md)
-  - [Security Specification](security-specifications.md)
+  - [Goals](project-goals.html) ([russian](project-goals-ru.html))
+  - [Original whitepaper](Whitepaper.html)
+  - [Brief intro](intro.html)
+  - [Security Specification](security-specifications.html)
 - Installation
-  - [Most Linuxes](install/linux.md) *TODO*
-  - [OpenWrt](install/openwrt.md)
-  - [Android](install/android.md) *TODO*
-  - [Firefox OS](install/firefoxos.md) *TODO*
-  - [OS X](install/osx.md)
-  - [Debian Wheezy](install/debian-wheezy.md)
-  - [Debian Jessie](install/debian-jessie.md)
-  - [Arch](install/arch.md)
-  - [Fedora](install/fedora.md)
-  - [FreeBSD](install/freebsd.md) *TODO*
-  - [OpenBSD](install/openbsd.md) *TODO*
-  - [Windows](install/windows.md)
-    - [Building *on* Windows](install/build-on-windows.md)
-    - [Securing your Windows system](config/windows-firewall.md)
+  - [Most Linuxes](install/linux.html) *TODO*
+  - [OpenWrt](install/openwrt.html)
+  - [Android](install/android.html) *TODO*
+  - [Firefox OS](install/firefoxos.html) *TODO*
+  - [OS X](install/osx.html)
+  - [Debian Wheezy](install/debian-wheezy.html)
+  - [Debian Jessie](install/debian-jessie.html)
+  - [Arch](install/arch.html)
+  - [Fedora](install/fedora.html)
+  - [FreeBSD](install/freebsd.html) *TODO*
+  - [OpenBSD](install/openbsd.html) *TODO*
+  - [Windows](install/windows.html)
+    - [Building *on* Windows](install/build-on-windows.html)
+    - [Securing your Windows system](config/windows-firewall.html)
 - Usage
-  - [Setup](config/configure.md)
-  - [Operator guidelines](cjdns/operator-guidelines.md)
-  - [Securing your system](config/network-services.md)
-  - [Tools](tools/index.md) *TODO*
-    - [Third party tools](ctrls.md)
-  - [Admin API](cjdns/admin-api.md)
+  - [Setup](config/configure.html)
+  - [Operator guidelines](cjdns/operator-guidelines.html)
+  - [Securing your system](config/network-services.html)
+  - [Tools](tools/index.html) *TODO*
+    - [Third party tools](ctrls.html)
+  - [Admin API](cjdns/admin-api.html)
 - Working with cjdns
-  - [Anatomy of cjdroute](cjdns/anatomy.md)
-  - [Peering over UDP](cjdns/peering-over-UDP-IP.md)
-  - [nodeinfo.json](cjdns/nodeinfo-json.md)
-  - [Changelog](cjdns/changelog.md)
+  - [Anatomy of cjdroute](cjdns/anatomy.html)
+  - [Peering over UDP](cjdns/peering-over-UDP-IP.html)
+  - [nodeinfo.json](cjdns/nodeinfo-json.html)
+  - [Changelog](cjdns/changelog.html)
 - HowTo
-  - [Using cjdns as a VPN](config/tunnel.md)
-  - [Shorewall and VPN gateway](config/shorewall-and-vpn-gateway-howto.md)
-  - [NAT gateway for non-cjdns nodes](config/nat-gateway.md)
-  - [Autostart at login](config/autostart-at-login.md)
-  - [Run as non-root user](config/non-root-user.md)
+  - [Using cjdns as a VPN](config/tunnel.html)
+  - [Shorewall and VPN gateway](config/shorewall-and-vpn-gateway-howto.html)
+  - [NAT gateway for non-cjdns nodes](config/nat-gateway.html)
+  - [Autostart at login](config/autostart-at-login.html)
+  - [Run as non-root user](config/non-root-user.html)
 - Troubleshooting
-  - [Read this first](bugs/policy.md)
-  - [Memory leaks](bugs/debugging-memory-leaks.md)
-  - [SecComp](bugs/Seccomp.md)
-  - [Analyzing network IO](traffic-analysis.md)
+  - [Read this first](bugs/policy.html)
+  - [Memory leaks](bugs/debugging-memory-leaks.html)
+  - [SecComp](bugs/Seccomp.html)
+  - [Analyzing network IO](traffic-analysis.html)
   - Known issues
-    - [Horizon](bugs/horizon.md)
-    - [Black Hole](bugs/black-hole.md)
-    - [Secret Santa](bugs/santa.md)
+    - [Horizon](bugs/horizon.html)
+    - [Black Hole](bugs/black-hole.html)
+    - [Secret Santa](bugs/santa.html)
     - Configurator timeout
-      - [Firewall on localhost](bugs/configurator-timeout.md)
-      - [UDP overflow](bugs/connectTo-overflow.md)
-    - ~~[Hidden Peers](bugs/hidden-peers.md)~~
-    - [OS/distro-specific quirks](bugs/distro-quirks.md)
-  - [Reporting bugs](bugs/reporting.md)
+      - [Firewall on localhost](bugs/configurator-timeout.html)
+      - [UDP overflow](bugs/connectTo-overflow.html)
+    - ~~[Hidden Peers](bugs/hidden-peers.html)~~
+    - [OS/distro-specific quirks](bugs/distro-quirks.html)
+  - [Reporting bugs](bugs/reporting.html)
 
 
 ## Random notes, work-in-progress, inbox
 
 These notes are unstructured, and most of them likely outdated.
 
-* [Interesting links](notes/links.md)
-* [ansuz' Q&A with Arceliar](notes/arc-workings.md)
-* [cjdns-core](notes/cjdns-core.md)
-* [cryptography](notes/cryptography.md)
-* [cjdroute.conf](notes/cjdroute-conf.md)
-* [./do](notes/do.md)
-* [DNS ideas](notes/dns.md)
-* [DJC layer model](djc-layer-model.md)
+* [Interesting links](notes/links.html)
+* [ansuz' Q&A with Arceliar](notes/arc-workings.html)
+* [cjdns-core](notes/cjdns-core.html)
+* [cryptography](notes/cryptography.html)
+* [cjdroute.conf](notes/cjdroute-conf.html)
+* [./do](notes/do.html)
+* [DNS ideas](notes/dns.html)
+* [DJC layer model](djc-layer-model.html)
 * [Benchmarks](benchmark.txt)
 * [Fun with the switch](switchfun.txt)
 

From 6a379cd1ed69b5b32b54afab12c0697cc7252393 Mon Sep 17 00:00:00 2001
From: Geoffroy Schmitlin <geoffroy.schmitlin@phiropsi.com>
Date: Mon, 15 Feb 2016 16:39:15 +0100
Subject: [PATCH 4/4] Parse content in jinja to replace .md links into .html.
 Now index.md stays viewable in github.

---
 hyperboria-theme/page.html |   5 ++
 index.md                   | 124 ++++++++++++++++++-------------------
 2 files changed, 67 insertions(+), 62 deletions(-)
 create mode 100644 hyperboria-theme/page.html

diff --git a/hyperboria-theme/page.html b/hyperboria-theme/page.html
new file mode 100644
index 00000000..6898a285
--- /dev/null
+++ b/hyperboria-theme/page.html
@@ -0,0 +1,5 @@
+{%- extends "hyperboria-theme/layout.html" %}
+
+{% block body %}
+  {{ body|replace('.md', '.html') }}
+{% endblock %}
\ No newline at end of file
diff --git a/index.md b/index.md
index 654d5409..f77014d6 100755
--- a/index.md
+++ b/index.md
@@ -17,86 +17,86 @@ You can contribute to its documentaion: https://github.com/hyperboria/docs
 
 ## About Hyperboria
 
-- [Asking Questions](wtfm.html) *TODO*
-- [Peering](faq/peering.html)
-- [Security](faq/security.html)
-- [Meshlocals](meshlocals/intro.html)
-  - [Meshlocals around the world](meshlocals/existing/index.html)
-  - [Starting a Meshlocal](meshlocals/diy.html)
-- [FAQ](faq/general.html)
-- [Achievements](achievements.html)
-- [Glossary](faq/glossary.html)
+- [Asking Questions](wtfm.md) *TODO*
+- [Peering](faq/peering.md)
+- [Security](faq/security.md)
+- [Meshlocals](meshlocals/intro.md)
+  - [Meshlocals around the world](meshlocals/existing/index.md)
+  - [Starting a Meshlocal](meshlocals/diy.md)
+- [FAQ](faq/general.md)
+- [Achievements](achievements.md)
+- [Glossary](faq/glossary.md)
 
 
 ## The cjdns routing protocol
 
 - About
-  - [Goals](project-goals.html) ([russian](project-goals-ru.html))
-  - [Original whitepaper](Whitepaper.html)
-  - [Brief intro](intro.html)
-  - [Security Specification](security-specifications.html)
+  - [Goals](project-goals.md) ([russian](project-goals-ru.md))
+  - [Original whitepaper](Whitepaper.md)
+  - [Brief intro](intro.md)
+  - [Security Specification](security-specifications.md)
 - Installation
-  - [Most Linuxes](install/linux.html) *TODO*
-  - [OpenWrt](install/openwrt.html)
-  - [Android](install/android.html) *TODO*
-  - [Firefox OS](install/firefoxos.html) *TODO*
-  - [OS X](install/osx.html)
-  - [Debian Wheezy](install/debian-wheezy.html)
-  - [Debian Jessie](install/debian-jessie.html)
-  - [Arch](install/arch.html)
-  - [Fedora](install/fedora.html)
-  - [FreeBSD](install/freebsd.html) *TODO*
-  - [OpenBSD](install/openbsd.html) *TODO*
-  - [Windows](install/windows.html)
-    - [Building *on* Windows](install/build-on-windows.html)
-    - [Securing your Windows system](config/windows-firewall.html)
+  - [Most Linuxes](install/linux.md) *TODO*
+  - [OpenWrt](install/openwrt.md)
+  - [Android](install/android.md) *TODO*
+  - [Firefox OS](install/firefoxos.md) *TODO*
+  - [OS X](install/osx.md)
+  - [Debian Wheezy](install/debian-wheezy.md)
+  - [Debian Jessie](install/debian-jessie.md)
+  - [Arch](install/arch.md)
+  - [Fedora](install/fedora.md)
+  - [FreeBSD](install/freebsd.md) *TODO*
+  - [OpenBSD](install/openbsd.md) *TODO*
+  - [Windows](install/windows.md)
+    - [Building *on* Windows](install/build-on-windows.md)
+    - [Securing your Windows system](config/windows-firewall.md)
 - Usage
-  - [Setup](config/configure.html)
-  - [Operator guidelines](cjdns/operator-guidelines.html)
-  - [Securing your system](config/network-services.html)
-  - [Tools](tools/index.html) *TODO*
-    - [Third party tools](ctrls.html)
-  - [Admin API](cjdns/admin-api.html)
+  - [Setup](config/configure.md)
+  - [Operator guidelines](cjdns/operator-guidelines.md)
+  - [Securing your system](config/network-services.md)
+  - [Tools](tools/index.md) *TODO*
+    - [Third party tools](ctrls.md)
+  - [Admin API](cjdns/admin-api.md)
 - Working with cjdns
-  - [Anatomy of cjdroute](cjdns/anatomy.html)
-  - [Peering over UDP](cjdns/peering-over-UDP-IP.html)
-  - [nodeinfo.json](cjdns/nodeinfo-json.html)
-  - [Changelog](cjdns/changelog.html)
+  - [Anatomy of cjdroute](cjdns/anatomy.md)
+  - [Peering over UDP](cjdns/peering-over-UDP-IP.md)
+  - [nodeinfo.json](cjdns/nodeinfo-json.md)
+  - [Changelog](cjdns/changelog.md)
 - HowTo
-  - [Using cjdns as a VPN](config/tunnel.html)
-  - [Shorewall and VPN gateway](config/shorewall-and-vpn-gateway-howto.html)
-  - [NAT gateway for non-cjdns nodes](config/nat-gateway.html)
-  - [Autostart at login](config/autostart-at-login.html)
-  - [Run as non-root user](config/non-root-user.html)
+  - [Using cjdns as a VPN](config/tunnel.md)
+  - [Shorewall and VPN gateway](config/shorewall-and-vpn-gateway-howto.md)
+  - [NAT gateway for non-cjdns nodes](config/nat-gateway.md)
+  - [Autostart at login](config/autostart-at-login.md)
+  - [Run as non-root user](config/non-root-user.md)
 - Troubleshooting
-  - [Read this first](bugs/policy.html)
-  - [Memory leaks](bugs/debugging-memory-leaks.html)
-  - [SecComp](bugs/Seccomp.html)
-  - [Analyzing network IO](traffic-analysis.html)
+  - [Read this first](bugs/policy.md)
+  - [Memory leaks](bugs/debugging-memory-leaks.md)
+  - [SecComp](bugs/Seccomp.md)
+  - [Analyzing network IO](traffic-analysis.md)
   - Known issues
-    - [Horizon](bugs/horizon.html)
-    - [Black Hole](bugs/black-hole.html)
-    - [Secret Santa](bugs/santa.html)
+    - [Horizon](bugs/horizon.md)
+    - [Black Hole](bugs/black-hole.md)
+    - [Secret Santa](bugs/santa.md)
     - Configurator timeout
-      - [Firewall on localhost](bugs/configurator-timeout.html)
-      - [UDP overflow](bugs/connectTo-overflow.html)
-    - ~~[Hidden Peers](bugs/hidden-peers.html)~~
-    - [OS/distro-specific quirks](bugs/distro-quirks.html)
-  - [Reporting bugs](bugs/reporting.html)
+      - [Firewall on localhost](bugs/configurator-timeout.md)
+      - [UDP overflow](bugs/connectTo-overflow.md)
+    - ~~[Hidden Peers](bugs/hidden-peers.md)~~
+    - [OS/distro-specific quirks](bugs/distro-quirks.md)
+  - [Reporting bugs](bugs/reporting.md)
 
 
 ## Random notes, work-in-progress, inbox
 
 These notes are unstructured, and most of them likely outdated.
 
-* [Interesting links](notes/links.html)
-* [ansuz' Q&A with Arceliar](notes/arc-workings.html)
-* [cjdns-core](notes/cjdns-core.html)
-* [cryptography](notes/cryptography.html)
-* [cjdroute.conf](notes/cjdroute-conf.html)
-* [./do](notes/do.html)
-* [DNS ideas](notes/dns.html)
-* [DJC layer model](djc-layer-model.html)
+* [Interesting links](notes/links.md)
+* [ansuz' Q&A with Arceliar](notes/arc-workings.md)
+* [cjdns-core](notes/cjdns-core.md)
+* [cryptography](notes/cryptography.md)
+* [cjdroute.conf](notes/cjdroute-conf.md)
+* [./do](notes/do.md)
+* [DNS ideas](notes/dns.md)
+* [DJC layer model](djc-layer-model.md)
 * [Benchmarks](benchmark.txt)
 * [Fun with the switch](switchfun.txt)