├── doc ├── build │ ├── latex │ │ ├── rpi.idx │ │ ├── rpi.ind │ │ ├── rpi.pdf │ │ ├── aapl.png │ │ ├── htop.png │ │ ├── stock_app_main.png │ │ ├── stock_app_plotly.png │ │ ├── stock_app_results.png │ │ ├── python.ist │ │ ├── rpi.ilg │ │ ├── rpi.out │ │ ├── rpi.toc │ │ ├── Makefile │ │ ├── sphinxhowto.cls │ │ ├── sphinxmanual.cls │ │ └── rpi.aux │ ├── html │ │ ├── favicon.ico │ │ ├── objects.inv │ │ ├── _images │ │ │ ├── aapl.png │ │ │ ├── htop.png │ │ │ ├── stock_app_main.png │ │ │ ├── stock_app_plotly.png │ │ │ └── stock_app_results.png │ │ ├── _static │ │ │ ├── down.png │ │ │ ├── file.png │ │ │ ├── plus.png │ │ │ ├── up.png │ │ │ ├── minus.png │ │ │ ├── comment.png │ │ │ ├── favicon.ico │ │ │ ├── favicon_.ico │ │ │ ├── ajax-loader.gif │ │ │ ├── up-pressed.png │ │ │ ├── comment-bright.png │ │ │ ├── comment-close.png │ │ │ ├── down-pressed.png │ │ │ ├── tpq_logo_white.png │ │ │ ├── tpq_logo_left_cut.png │ │ │ ├── tpq_logo_more_left_cut.png │ │ │ ├── pygments.css │ │ │ ├── sidebar.js │ │ │ ├── default.css │ │ │ └── doctools.js │ │ ├── _downloads │ │ │ ├── flask_test.py │ │ │ ├── results.html │ │ │ ├── web_serve.py │ │ │ ├── run_stock_app.py │ │ │ ├── run_stock_int.py │ │ │ ├── plotly.html │ │ │ ├── forms.py │ │ │ ├── layout.html │ │ │ ├── style.css │ │ │ ├── large_data_set.py │ │ │ ├── selection.html │ │ │ ├── data_collection.py │ │ │ ├── mail_simple.py │ │ │ ├── stock_data.py │ │ │ ├── mail_attach.py │ │ │ └── stock_interactive.py │ │ ├── .buildinfo │ │ ├── add_font.py │ │ ├── _sources │ │ │ ├── 01_ftp_server.txt │ │ │ ├── 04_git_server.txt │ │ │ ├── index.txt │ │ │ ├── 00_basic_config.txt │ │ │ ├── 02_data_analytics.txt │ │ │ ├── 05_webcam.txt │ │ │ └── 03_web_apps.txt │ │ ├── genindex.html │ │ ├── search.html │ │ ├── 01_ftp_server.html │ │ └── searchindex.js │ ├── doctrees │ │ ├── .doctree │ │ ├── ftp.doctree │ │ ├── ftp2.doctree │ │ ├── 00_ssh.doctree │ │ ├── 02_ftp.doctree │ │ ├── 03_ftp.doctree │ │ ├── index.doctree │ │ ├── 05_webcam.doctree │ │ ├── 01_ipython.doctree │ │ ├── 02_web_app.doctree │ │ ├── 03_web_apps.doctree │ │ ├── environment.pickle │ │ ├── 00_ssh_access.doctree │ │ ├── 01_ftp_server.doctree │ │ ├── 04_git_server.doctree │ │ ├── 00_basic_config.doctree │ │ └── 02_data_analytics.doctree │ └── replace.py ├── source │ ├── rpi.sublime-project │ ├── aapl.png │ ├── htop.png │ ├── _static │ │ ├── favicon.ico │ │ ├── tpq_logo_white.png │ │ ├── tpq_logo_left_cut.png │ │ └── tpq_logo_more_left_cut.png │ ├── stock_app_main.png │ ├── stock_app_plotly.png │ ├── stock_app_results.png │ ├── stock_app │ │ ├── static │ │ │ ├── results.png │ │ │ └── style.css │ │ ├── templates │ │ │ ├── results.html │ │ │ ├── layout.html │ │ │ └── selection.html │ │ ├── run_stock_app.py │ │ ├── forms.py │ │ └── stock_data.py │ ├── flask_test.py │ ├── web_serve.py │ ├── stock_int │ │ ├── run_stock_int.py │ │ ├── templates │ │ │ ├── plotly.html │ │ │ ├── layout.html │ │ │ └── selection.html │ │ ├── forms.py │ │ ├── static │ │ │ └── style.css │ │ └── stock_interactive.py │ ├── large_data_set.py │ ├── data_collection.py │ ├── mail_simple.py │ ├── 01_ftp_server.rst │ ├── mail_attach.py │ ├── 04_git_server.rst │ ├── index.rst │ ├── 00_basic_config.rst │ ├── 02_data_analytics.rst │ ├── 05_webcam.rst │ ├── 03_web_apps.rst │ └── conf.py ├── _store │ ├── mail.py │ └── mail_attach.py └── Makefile ├── rpi.png ├── .ipynb_checkpoints └── testing-checkpoint.ipynb ├── README.md ├── .gitignore └── LICENSE /doc/build/latex/rpi.idx: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /doc/build/latex/rpi.ind: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /doc/source/rpi.sublime-project: -------------------------------------------------------------------------------- 1 | { 2 | } 3 | -------------------------------------------------------------------------------- /rpi.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/rpi.png -------------------------------------------------------------------------------- /doc/source/aapl.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/aapl.png -------------------------------------------------------------------------------- /doc/source/htop.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/htop.png -------------------------------------------------------------------------------- /doc/build/latex/rpi.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/latex/rpi.pdf -------------------------------------------------------------------------------- /doc/build/html/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/favicon.ico -------------------------------------------------------------------------------- /doc/build/html/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/objects.inv -------------------------------------------------------------------------------- /doc/build/latex/aapl.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/latex/aapl.png -------------------------------------------------------------------------------- /doc/build/latex/htop.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/latex/htop.png -------------------------------------------------------------------------------- /doc/build/doctrees/.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/ftp.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/ftp.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/ftp2.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/ftp2.doctree -------------------------------------------------------------------------------- /doc/build/html/_images/aapl.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_images/aapl.png -------------------------------------------------------------------------------- /doc/build/html/_images/htop.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_images/htop.png -------------------------------------------------------------------------------- /doc/build/html/_static/down.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/down.png -------------------------------------------------------------------------------- /doc/build/html/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/file.png -------------------------------------------------------------------------------- /doc/build/html/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/plus.png -------------------------------------------------------------------------------- /doc/build/html/_static/up.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/up.png -------------------------------------------------------------------------------- /doc/source/_static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/_static/favicon.ico -------------------------------------------------------------------------------- /doc/source/stock_app_main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/stock_app_main.png -------------------------------------------------------------------------------- /doc/source/stock_app_plotly.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/stock_app_plotly.png -------------------------------------------------------------------------------- /doc/build/doctrees/00_ssh.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/00_ssh.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/02_ftp.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/02_ftp.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/03_ftp.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/03_ftp.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/index.doctree -------------------------------------------------------------------------------- /doc/build/html/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/minus.png -------------------------------------------------------------------------------- /doc/source/stock_app_results.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/stock_app_results.png -------------------------------------------------------------------------------- /doc/build/doctrees/05_webcam.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/05_webcam.doctree -------------------------------------------------------------------------------- /doc/build/html/_static/comment.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/comment.png -------------------------------------------------------------------------------- /doc/build/html/_static/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/favicon.ico -------------------------------------------------------------------------------- /doc/build/html/_static/favicon_.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/favicon_.ico -------------------------------------------------------------------------------- /doc/build/latex/stock_app_main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/latex/stock_app_main.png -------------------------------------------------------------------------------- /doc/build/latex/stock_app_plotly.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/latex/stock_app_plotly.png -------------------------------------------------------------------------------- /doc/build/doctrees/01_ipython.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/01_ipython.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/02_web_app.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/02_web_app.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/03_web_apps.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/03_web_apps.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/environment.pickle -------------------------------------------------------------------------------- /doc/build/html/_static/ajax-loader.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/ajax-loader.gif -------------------------------------------------------------------------------- /doc/build/html/_static/up-pressed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/up-pressed.png -------------------------------------------------------------------------------- /doc/build/latex/stock_app_results.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/latex/stock_app_results.png -------------------------------------------------------------------------------- /doc/source/_static/tpq_logo_white.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/_static/tpq_logo_white.png -------------------------------------------------------------------------------- /doc/build/doctrees/00_ssh_access.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/00_ssh_access.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/01_ftp_server.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/01_ftp_server.doctree -------------------------------------------------------------------------------- /doc/build/doctrees/04_git_server.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/04_git_server.doctree -------------------------------------------------------------------------------- /doc/build/html/_images/stock_app_main.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_images/stock_app_main.png -------------------------------------------------------------------------------- /doc/build/html/_static/comment-bright.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/comment-bright.png -------------------------------------------------------------------------------- /doc/build/html/_static/comment-close.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/comment-close.png -------------------------------------------------------------------------------- /doc/build/html/_static/down-pressed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/down-pressed.png -------------------------------------------------------------------------------- /doc/build/html/_static/tpq_logo_white.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/tpq_logo_white.png -------------------------------------------------------------------------------- /doc/source/_static/tpq_logo_left_cut.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/_static/tpq_logo_left_cut.png -------------------------------------------------------------------------------- /doc/source/stock_app/static/results.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/stock_app/static/results.png -------------------------------------------------------------------------------- /doc/build/doctrees/00_basic_config.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/00_basic_config.doctree -------------------------------------------------------------------------------- /doc/build/html/_images/stock_app_plotly.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_images/stock_app_plotly.png -------------------------------------------------------------------------------- /doc/build/doctrees/02_data_analytics.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/doctrees/02_data_analytics.doctree -------------------------------------------------------------------------------- /doc/build/html/_images/stock_app_results.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_images/stock_app_results.png -------------------------------------------------------------------------------- /doc/build/html/_static/tpq_logo_left_cut.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/tpq_logo_left_cut.png -------------------------------------------------------------------------------- /doc/source/_static/tpq_logo_more_left_cut.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/source/_static/tpq_logo_more_left_cut.png -------------------------------------------------------------------------------- /doc/build/html/_static/tpq_logo_more_left_cut.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yhilpisch/rpi/master/doc/build/html/_static/tpq_logo_more_left_cut.png -------------------------------------------------------------------------------- /doc/source/flask_test.py: -------------------------------------------------------------------------------- 1 | # 2 | # From http://flask.pocoo.org 3 | # 4 | from flask import Flask 5 | app = Flask(__name__) 6 | 7 | @app.route("/") 8 | def hello(): 9 | return "Hello World!" 10 | -------------------------------------------------------------------------------- /doc/build/html/_downloads/flask_test.py: -------------------------------------------------------------------------------- 1 | # 2 | # From http://flask.pocoo.org 3 | # 4 | from flask import Flask 5 | app = Flask(__name__) 6 | 7 | @app.route("/") 8 | def hello(): 9 | return "Hello World!" 10 | -------------------------------------------------------------------------------- /.ipynb_checkpoints/testing-checkpoint.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "metadata": { 3 | "name": "", 4 | "signature": "sha256:9d8bdfea4595c163c5beb70b377dddfd74e1aa80692627a0c265e75845d6beed" 5 | }, 6 | "nbformat": 3, 7 | "nbformat_minor": 0, 8 | "worksheets": [] 9 | } -------------------------------------------------------------------------------- /doc/build/html/.buildinfo: -------------------------------------------------------------------------------- 1 | # Sphinx build info version 1 2 | # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. 3 | config: 32040a6f104c5b6125adeeb60ce4a91d 4 | tags: 645f666f9bcd5a90fca523b33c5a78b7 5 | -------------------------------------------------------------------------------- /doc/build/latex/python.ist: -------------------------------------------------------------------------------- 1 | line_max 100 2 | headings_flag 1 3 | heading_prefix " \\bigletter " 4 | 5 | preamble "\\begin{theindex} 6 | \\def\\bigletter#1{{\\Large\\sffamily#1}\\nopagebreak\\vspace{1mm}} 7 | 8 | " 9 | 10 | symhead_positive "{Symbols}" 11 | numhead_positive "{Numbers}" 12 | -------------------------------------------------------------------------------- /doc/build/latex/rpi.ilg: -------------------------------------------------------------------------------- 1 | This is makeindex, version 2.15 [TeX Live 2012] (kpathsea + Thai support). 2 | Scanning style file ./python.ist......done (6 attributes redefined, 0 ignored). 3 | Scanning input file rpi.idx...done (0 entries accepted, 0 rejected). 4 | Nothing written in rpi.ind. 5 | Transcript written in rpi.ilg. 6 | -------------------------------------------------------------------------------- /doc/build/html/_downloads/results.html: -------------------------------------------------------------------------------- 1 | 2 | {% extends "layout.html" %} 3 | 4 | {% block body %} 5 | 6 | 7 |
10 |
11 |
10 |
11 |
22 |
22 |
22 | 57 | Please activate JavaScript to enable the search 58 | functionality. 59 |
60 |62 | From here you can search these documents. Enter your search 63 | words into the box below and click "search". Note that the search 64 | function will automatically search for all of the words. Pages 65 | containing fewer words won't appear in the result list. 66 |
67 | 72 | 73 |Setting up the RPi as an FTP server—over which you and you alone have full control—is quite a simple task. First, install the ProFTP software through:
59 |sudo apt-get install proftpd
60 | Configure it to be “standalone”. Second, edit the config file of the program as follows:
63 |sudo nano /etc/proftpd/proftpd.conf
64 | Add the following parameters:
67 |DefaultRoot ~
68 | AuthOrder mod_auth_file.c mod_auth_unix.c
69 | AuthUserFile /etc/proftpd/ftpd.passwd
70 | AuthPAM off
71 | RequireValidShell off
72 | Restart the service by:
75 |sudo /etc/init.d/proftpd restart
76 | Third, generate a new user as follows:
79 |sudo adduser ftp --home /home/ftp --shell /bin/bash
80 | Change ftp and /home/ftp to a user name and directory of your liking. Choose a password for the new user.
83 |Using a FTP client, you can now connect to your RPi and, for example, store files on it. You can also ssh connect to the RPi using the new user credentials.
84 |Generally SD cards hosting the OS of the RPi and serving as file/data storage are of course not that large. But investing e.g. 50 EUR for a 500 GB external USB drive and connecting such a drive to the RPi is a simple way of using the RPi as a serious ftp server.
85 |' + _('Hide Search Matches') + '
') 181 | .appendTo($('#searchbox')); 182 | } 183 | }, 184 | 185 | /** 186 | * init the domain index toggle buttons 187 | */ 188 | initIndexTable : function() { 189 | var togglers = $('img.toggler').click(function() { 190 | var src = $(this).attr('src'); 191 | var idnum = $(this).attr('id').substr(7); 192 | $('tr.cg-' + idnum).toggle(); 193 | if (src.substr(-9) == 'minus.png') 194 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 195 | else 196 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 197 | }).css('display', ''); 198 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 199 | togglers.click(); 200 | } 201 | }, 202 | 203 | /** 204 | * helper function to hide the search marks again 205 | */ 206 | hideSearchWords : function() { 207 | $('#searchbox .highlight-link').fadeOut(300); 208 | $('span.highlighted').removeClass('highlighted'); 209 | }, 210 | 211 | /** 212 | * make the url absolute 213 | */ 214 | makeURL : function(relativeURL) { 215 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 216 | }, 217 | 218 | /** 219 | * get the current relative url 220 | */ 221 | getCurrentURL : function() { 222 | var path = document.location.pathname; 223 | var parts = path.split(/\//); 224 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 225 | if (this == '..') 226 | parts.pop(); 227 | }); 228 | var url = parts.join('/'); 229 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 230 | } 231 | }; 232 | 233 | // quick alias for translations 234 | _ = Documentation.gettext; 235 | 236 | $(document).ready(function() { 237 | Documentation.init(); 238 | }); 239 | -------------------------------------------------------------------------------- /doc/source/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # dx documentation build configuration file, created by 4 | # sphinx-quickstart on Mon Nov 10 07:53:46 2014. 5 | # 6 | # This file is execfile()d with the current directory set to its 7 | # containing dir. 8 | # 9 | # Note that not all possible configuration values are present in this 10 | # autogenerated file. 11 | # 12 | # All configuration values have a default; values that are commented out 13 | # serve to show the default. 14 | 15 | import sys 16 | import os 17 | 18 | # If extensions (or modules to document with autodoc) are in another directory, 19 | # add these directories to sys.path here. If the directory is relative to the 20 | # documentation root, use os.path.abspath to make it absolute, like shown here. 21 | #sys.path.insert(0, os.path.abspath('.')) 22 | 23 | # -- General configuration ------------------------------------------------ 24 | 25 | # If your documentation needs a minimal Sphinx version, state it here. 26 | #needs_sphinx = '1.0' 27 | 28 | # Add any Sphinx extension module names here, as strings. They can be 29 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 30 | # ones. 31 | extensions = [ 32 | 'sphinx.ext.todo', 33 | 'sphinx.ext.mathjax', 34 | 'sphinx.ext.ifconfig', 35 | 'IPython.sphinxext.ipython_console_highlighting', 36 | 'IPython.sphinxext.ipython_directive' 37 | ] 38 | 39 | # Add any paths that contain templates here, relative to this directory. 40 | templates_path = ['_templates'] 41 | 42 | # The suffix of source filenames. 43 | source_suffix = '.rst' 44 | 45 | # The encoding of source files. 46 | #source_encoding = 'utf-8-sig' 47 | 48 | # The master toctree document. 49 | master_doc = 'index' 50 | 51 | # General information about the project. 52 | project = u'dx' 53 | copyright = u'2014, Yves J. Hilpisch' 54 | 55 | # The version info for the project you're documenting, acts as replacement for 56 | # |version| and |release|, also used in various other places throughout the 57 | # built documents. 58 | # 59 | # The short X.Y version. 60 | version = '0.1' 61 | # The full version, including alpha/beta/rc tags. 62 | release = '0.1' 63 | 64 | # The language for content autogenerated by Sphinx. Refer to documentation 65 | # for a list of supported languages. 66 | #language = None 67 | 68 | # There are two options for replacing |today|: either, you set today to some 69 | # non-false value, then it is used: 70 | #today = '' 71 | # Else, today_fmt is used as the format for a strftime call. 72 | #today_fmt = '%B %d, %Y' 73 | 74 | # List of patterns, relative to source directory, that match files and 75 | # directories to ignore when looking for source files. 76 | exclude_patterns = ['XX'] 77 | 78 | # The reST default role (used for this markup: `text`) to use for all 79 | # documents. 80 | #default_role = None 81 | 82 | # If true, '()' will be appended to :func: etc. cross-reference text. 83 | #add_function_parentheses = True 84 | 85 | # If true, the current module name will be prepended to all description 86 | # unit titles (such as .. function::). 87 | #add_module_names = True 88 | 89 | # If true, sectionauthor and moduleauthor directives will be shown in the 90 | # output. They are ignored by default. 91 | #show_authors = False 92 | 93 | # The name of the Pygments (syntax highlighting) style to use. 94 | pygments_style = 'sphinx' 95 | 96 | # A list of ignored prefixes for module index sorting. 97 | #modindex_common_prefix = [] 98 | 99 | # If true, keep warnings as "system message" paragraphs in the built documents. 100 | #keep_warnings = False 101 | 102 | 103 | # -- Options for HTML output ---------------------------------------------- 104 | 105 | # The theme to use for HTML and HTML Help pages. See the documentation for 106 | # a list of builtin themes. 107 | html_theme = 'default' 108 | 109 | # Theme options are theme-specific and customize the look and feel of a theme 110 | # further. For a list of options available for each theme, see the 111 | # documentation. 112 | html_theme_options = { 113 | "bodyfont": "PT Sans", 114 | "headfont": "PT Sans", 115 | "bgcolor": "#ffffff", 116 | "textcolor": "#000000", 117 | "headtextcolor": "#0B3861", 118 | "sidebarbgcolor": "#0B3861", 119 | "sidebarlinkcolor": "#25A8E0", 120 | # "headbgcolor": "#0B3861", 121 | # "headtextcolor": "#ffffff", 122 | "headlinkcolor": "#25A8E0", 123 | "footerbgcolor": "#0B3861", 124 | "footertextcolor": "#ffffff", 125 | "relbarbgcolor": "#0B3861", 126 | "relbartextcolor": "#ffffff", 127 | "relbarlinkcolor": "#25A8E0", 128 | "codebgcolor": "#D8D8D8", 129 | "sidebarwidth": "280", 130 | "stickysidebar": True 131 | 132 | } 133 | 134 | 135 | # Add any paths that contain custom themes here, relative to this directory. 136 | #html_theme_path = [] 137 | 138 | # The name for this set of Sphinx documents. If None, it defaults to 139 | # "