|
15 | 15 | import os |
16 | 16 | import sys |
17 | 17 | import recommonmark |
| 18 | +from recommonmark.transform import AutoStructify |
18 | 19 |
|
19 | 20 | sys.path.insert(0, os.path.abspath('.')) |
20 | 21 |
|
|
26 | 27 | author = 'nteract project' |
27 | 28 |
|
28 | 29 | # The short X.Y version |
29 | | -version = '' |
| 30 | +version = '0.1' |
30 | 31 | # The full version, including alpha/beta/rc tags |
31 | | -release = '' |
| 32 | +release = '0.1.0' |
32 | 33 |
|
33 | 34 |
|
34 | 35 | # -- General configuration --------------------------------------------------- |
|
48 | 49 | # Add any paths that contain templates here, relative to this directory. |
49 | 50 | templates_path = ['_templates'] |
50 | 51 |
|
| 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 | + |
51 | 61 | # source parsers |
52 | 62 | source_parsers = {'.md': 'recommonmark.parser.CommonMarkParser'} |
53 | 63 |
|
|
81 | 91 | # |
82 | 92 | html_theme = 'alabaster' |
83 | 93 |
|
| 94 | +html_logo = '_static/images/nteract_logo_compact_purple.png' |
| 95 | + |
84 | 96 | # Theme options are theme-specific and customize the look and feel of a theme |
85 | 97 | # further. For a list of options available for each theme, see the |
86 | 98 | # documentation. |
87 | 99 | # |
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 | +} |
89 | 113 |
|
90 | 114 | # Add any paths that contain custom static files (such as style sheets) here, |
91 | 115 | # relative to this directory. They are copied after the builtin static files, |
|
100 | 124 | # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', |
101 | 125 | # 'searchbox.html']``. |
102 | 126 | # |
103 | | -# html_sidebars = {} |
| 127 | +html_sidebars = { |
| 128 | + '**': [ |
| 129 | + 'about.html', |
| 130 | + 'searchbox.html', |
| 131 | + 'navigation.html', |
| 132 | + 'sourcelink.html', |
| 133 | + ], |
| 134 | +} |
104 | 135 |
|
105 | 136 |
|
106 | 137 | # -- Options for HTMLHelp output --------------------------------------------- |
|
0 commit comments