Merge pull request #2 from xmnlab/master

Add rtd theme and xnd.io visual identity.

doc/.gitignore

@@ -0,0 +1 @@
+build/

doc/Makefile

@@ -5,10 +5,10 @@ BUILDDIR = build
 default: html
 
 html:
-	sphinx-build -b html -d build/doctrees . build/html
+	${SPHINXBUILD} -b html -d build/doctrees . build/html
 
 doctest:
-	sphinx-build -b doctest -d build/doctrees . build/html
+	${SPHINXBUILD} -b doctest -d build/doctrees . build/html
 
 clean:
 	rm -rf $(BUILDDIR)/*

doc/_static/style.css

@@ -0,0 +1,7 @@
+.wy-side-nav-search {
+  background-color: #e9ecef;
+}
+
+.wy-side-nav-search>div.version {
+  color: #333333;
+}

doc/_templates/layout.html

@@ -0,0 +1,2 @@
+{% extends "!layout.html" %}
+{% set css_files = css_files + ["_static/style.css"] %}

doc/conf.py

@@ -1,26 +1,64 @@
 import sys, os, docutils
 
 
-extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.doctest']
+extensions = [
+    'sphinx.ext.intersphinx', 
+    'sphinx.ext.doctest',
+    'sphinx.ext.extlinks'
+]
 
 source_suffix = '.rst'
 master_doc = 'index'
-project = 'ndtypes'
+project = 'Plures'
 copyright = '2017-2018, Plures Project'
 version = 'v0.2.0dev3'
 release = 'v0.2.0dev3'
 exclude_patterns = ['doc', 'build']
 pygments_style = 'sphinx'
+
 html_static_path = ['_static']
+templates_path = ['_templates']
 
 primary_domain = 'py'
 add_function_parentheses = False
 
+html_theme = "sphinx_rtd_theme"
+html_theme_path = ["_themes", ]
+
+html_theme_options = {
+    'canonical_url': 'https://xnd.io/',
+    'analytics_id': '',
+    'logo_only': True,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    # Toc options
+    'collapse_navigation': True,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': False,
+}
+
+html_context = {
+    "display_github": False, # Add 'Edit on Github' link instead of 'View page source'
+    "last_updated": True,
+    "commit": False,
+}
+
+html_show_sourcelink = False
+
+extlinks = {
+    'issue': ('https://github.com/plures/xnd/issues/%s', 'GH#'),
+    'pr': ('https://github.com/plures/xnd/pull/%s', 'GH#')
+}
+
+html_logo = "images/xndlogo.png"
+
 
 def setup(app):
-    app.add_crossref_type('topic', 'topic', 'single: %s',
-                          docutils.nodes.strong)
+    app.add_crossref_type(
+        'topic', 'topic', 'single: %s', docutils.nodes.strong
+    )
     app.add_javascript("copybutton.js")
 
 
-

doc/requirements.txt

@@ -0,0 +1,2 @@
+sphinx
+sphinx_rtd_theme