Skip to content

Commit

Permalink
Applied theme from the XND documentation (#56).
Browse files Browse the repository at this point in the history
  • Loading branch information
acu192 authored and skrah committed Nov 2, 2018
1 parent 0880027 commit fc7eaaf
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 4 deletions.
7 changes: 7 additions & 0 deletions doc/_static/style.css
@@ -0,0 +1,7 @@
.wy-side-nav-search {
background-color: #e9ecef;
}

.wy-side-nav-search>div.version {
color: #333333;
}
2 changes: 2 additions & 0 deletions doc/_templates/layout.html
@@ -0,0 +1,2 @@
{% extends "!layout.html" %}
{% set css_files = css_files + ["_static/style.css"] %}
44 changes: 40 additions & 4 deletions doc/conf.py
@@ -1,7 +1,11 @@
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'
Expand All @@ -11,16 +15,48 @@
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,
}

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/ndtypes/issues/%s', 'GH#'),
'pr': ('https://github.com/plures/ndtypes/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")



Binary file added doc/images/xndlogo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions doc/requirements.txt
@@ -0,0 +1,2 @@
sphinx
sphinx_rtd_theme

0 comments on commit fc7eaaf

Please sign in to comment.