Skip to content
This repository was archived by the owner on Feb 21, 2026. It is now read-only.

Commit 07d1e1d

Browse files
authored
Merge pull request #5 from willingc/tidy-docs
update details in doc config
2 parents 88bd90c + 02e9845 commit 07d1e1d

File tree

4 files changed

+35
-4
lines changed

4 files changed

+35
-4
lines changed
58.1 KB
Loading
12.9 KB
Loading

docs/source/_templates/.keep

Whitespace-only changes.

docs/source/conf.py

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
import os
1616
import sys
1717
import recommonmark
18+
from recommonmark.transform import AutoStructify
1819

1920
sys.path.insert(0, os.path.abspath('.'))
2021

@@ -26,9 +27,9 @@
2627
author = 'nteract project'
2728

2829
# The short X.Y version
29-
version = ''
30+
version = '0.1'
3031
# The full version, including alpha/beta/rc tags
31-
release = ''
32+
release = '0.1.0'
3233

3334

3435
# -- General configuration ---------------------------------------------------
@@ -48,6 +49,15 @@
4849
# Add any paths that contain templates here, relative to this directory.
4950
templates_path = ['_templates']
5051

52+
# allows recommonmark to provide improved toctree with markdown
53+
def setup(app):
54+
app.add_config_value('recommonmark_config', {
55+
'enable_eval_rst': True,
56+
'enable_auto_doc_ref': True,
57+
}, True)
58+
app.add_stylesheet('custom.css')
59+
app.add_transform(AutoStructify)
60+
5161
# source parsers
5262
source_parsers = {'.md': 'recommonmark.parser.CommonMarkParser'}
5363

@@ -81,11 +91,25 @@
8191
#
8292
html_theme = 'alabaster'
8393

94+
html_logo = '_static/images/nteract_logo_compact_purple.png'
95+
8496
# Theme options are theme-specific and customize the look and feel of a theme
8597
# further. For a list of options available for each theme, see the
8698
# documentation.
8799
#
88-
# html_theme_options = {}
100+
html_theme_options = {
101+
'show_related': True,
102+
'description': 'Notebook storage workflows for the masses.',
103+
'github_user': 'nteract',
104+
'github_repo': 'bookstore',
105+
'github_banner': False,
106+
'github_button': False,
107+
'show_powered_by': True,
108+
'extra_nav_links': {
109+
'GitHub Repo': 'http://github.com/nteract/bookstore',
110+
'Issue Tracker': 'http://github.com/nteract/bookstore/issues',
111+
},
112+
}
89113

90114
# Add any paths that contain custom static files (such as style sheets) here,
91115
# relative to this directory. They are copied after the builtin static files,
@@ -100,7 +124,14 @@
100124
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
101125
# 'searchbox.html']``.
102126
#
103-
# html_sidebars = {}
127+
html_sidebars = {
128+
'**': [
129+
'about.html',
130+
'searchbox.html',
131+
'navigation.html',
132+
'sourcelink.html',
133+
],
134+
}
104135

105136

106137
# -- Options for HTMLHelp output ---------------------------------------------

0 commit comments

Comments
 (0)