├── .gitignore ├── LICENSE ├── README.md ├── code ├── 02-setup │ ├── Makefile │ ├── _build │ │ ├── doctrees │ │ │ ├── about_us.doctree │ │ │ ├── environment.pickle │ │ │ └── index.doctree │ │ └── html │ │ │ ├── _sources │ │ │ ├── about_us.md.txt │ │ │ └── index.rst.txt │ │ │ ├── _static │ │ │ ├── alabaster.css │ │ │ ├── basic.css │ │ │ ├── custom.css │ │ │ ├── doctools.js │ │ │ ├── documentation_options.js │ │ │ ├── file.png │ │ │ ├── jquery-3.5.1.js │ │ │ ├── jquery.js │ │ │ ├── language_data.js │ │ │ ├── minus.png │ │ │ ├── plus.png │ │ │ ├── pygments.css │ │ │ ├── searchtools.js │ │ │ ├── underscore-1.13.1.js │ │ │ └── underscore.js │ │ │ ├── about_us.html │ │ │ ├── genindex.html │ │ │ ├── index.html │ │ │ ├── objects.inv │ │ │ ├── search.html │ │ │ └── searchindex.js │ ├── about_us.md │ ├── conf.py │ ├── index.md │ ├── make.bat │ ├── requirements.txt │ └── run_livereload.py ├── 03-simple-markdown │ ├── Makefile │ ├── _build │ │ ├── doctrees │ │ │ ├── about_us.doctree │ │ │ ├── environment.pickle │ │ │ └── index.doctree │ │ └── html │ │ │ ├── _images │ │ │ └── python-logo.png │ │ │ ├── _sources │ │ │ ├── about_us.md.txt │ │ │ ├── index.md.txt │ │ │ └── index.rst.txt │ │ │ ├── _static │ │ │ ├── alabaster.css │ │ │ ├── basic.css │ │ │ ├── custom.css │ │ │ ├── doctools.js │ │ │ ├── documentation_options.js │ │ │ ├── file.png │ │ │ ├── jquery-3.5.1.js │ │ │ ├── jquery.js │ │ │ ├── language_data.js │ │ │ ├── minus.png │ │ │ ├── plus.png │ │ │ ├── pygments.css │ │ │ ├── searchtools.js │ │ │ ├── underscore-1.13.1.js │ │ │ └── underscore.js │ │ │ ├── about_us.html │ │ │ ├── genindex.html │ │ │ ├── index.html │ │ │ ├── objects.inv │ │ │ ├── search.html │ │ │ └── searchindex.js │ ├── about_us.md │ ├── conf.py │ ├── index.md │ ├── make.bat │ ├── python-logo.png │ ├── requirements.txt │ └── run_livereload.py ├── 04-more-authoring │ ├── Makefile │ ├── _build │ │ ├── doctrees │ │ │ ├── about_us.doctree │ │ │ ├── environment.pickle │ │ │ └── index.doctree │ │ └── html │ │ │ ├── _downloads │ │ │ └── 26f0333ad80ad765dabb1115dde48966 │ │ │ │ └── python-logo.png │ │ │ ├── _images │ │ │ └── python-logo.png │ │ │ ├── _sources │ │ │ ├── about_us.md.txt │ │ │ ├── index.md.txt │ │ │ └── index.rst.txt │ │ │ ├── _static │ │ │ ├── alabaster.css │ │ │ ├── basic.css │ │ │ ├── custom.css │ │ │ ├── doctools.js │ │ │ ├── documentation_options.js │ │ │ ├── file.png │ │ │ ├── jquery-3.5.1.js │ │ │ ├── jquery.js │ │ │ ├── language_data.js │ │ │ ├── minus.png │ │ │ ├── plus.png │ │ │ ├── pygments.css │ │ │ ├── searchtools.js │ │ │ ├── underscore-1.13.1.js │ │ │ └── underscore.js │ │ │ ├── about_us.html │ │ │ ├── genindex.html │ │ │ ├── index.html │ │ │ ├── objects.inv │ │ │ ├── search.html │ │ │ └── searchindex.js │ ├── about_us.md │ ├── conf.py │ ├── index.md │ ├── make.bat │ ├── python-logo.png │ ├── requirements.txt │ └── run_livereload.py ├── 05-linking │ ├── Makefile │ ├── _build │ │ ├── doctrees │ │ │ ├── about_us.doctree │ │ │ ├── environment.pickle │ │ │ └── index.doctree │ │ └── html │ │ │ ├── _downloads │ │ │ └── 26f0333ad80ad765dabb1115dde48966 │ │ │ │ └── python-logo.png │ │ │ ├── _images │ │ │ └── python-logo.png │ │ │ ├── _sources │ │ │ ├── about_us.md.txt │ │ │ ├── index.md.txt │ │ │ └── index.rst.txt │ │ │ ├── _static │ │ │ ├── alabaster.css │ │ │ ├── basic.css │ │ │ ├── custom.css │ │ │ ├── doctools.js │ │ │ ├── documentation_options.js │ │ │ ├── file.png │ │ │ ├── jquery-3.5.1.js │ │ │ ├── jquery.js │ │ │ ├── language_data.js │ │ │ ├── minus.png │ │ │ ├── plus.png │ │ │ ├── pygments.css │ │ │ ├── searchtools.js │ │ │ ├── underscore-1.13.1.js │ │ │ └── underscore.js │ │ │ ├── about_us.html │ │ │ ├── genindex.html │ │ │ ├── index.html │ │ │ ├── objects.inv │ │ │ ├── search.html │ │ │ └── searchindex.js │ ├── about_us.md │ ├── conf.py │ ├── index.md │ ├── make.bat │ ├── python-logo.png │ ├── requirements.txt │ └── run_livereload.py ├── 06-documenting-code │ ├── Makefile │ ├── _build │ │ ├── doctrees │ │ │ ├── about_us.doctree │ │ │ ├── environment.pickle │ │ │ └── index.doctree │ │ └── html │ │ │ ├── _downloads │ │ │ └── 26f0333ad80ad765dabb1115dde48966 │ │ │ │ └── python-logo.png │ │ │ ├── _images │ │ │ └── python-logo.png │ │ │ ├── _sources │ │ │ ├── about_us.md.txt │ │ │ ├── index.md.txt │ │ │ └── index.rst.txt │ │ │ ├── _static │ │ │ ├── alabaster.css │ │ │ ├── basic.css │ │ │ ├── custom.css │ │ │ ├── doctools.js │ │ │ ├── documentation_options.js │ │ │ ├── file.png │ │ │ ├── jquery-3.5.1.js │ │ │ ├── jquery.js │ │ │ ├── language_data.js │ │ │ ├── minus.png │ │ │ ├── plus.png │ │ │ ├── pygments.css │ │ │ ├── searchtools.js │ │ │ ├── underscore-1.13.1.js │ │ │ └── underscore.js │ │ │ ├── about_us.html │ │ │ ├── genindex.html │ │ │ ├── index.html │ │ │ ├── objects.inv │ │ │ ├── search.html │ │ │ └── searchindex.js │ ├── about_us.md │ ├── conf.py │ ├── index.md │ ├── make.bat │ ├── my_demo.py │ ├── python-logo.png │ ├── requirements.txt │ └── run_livereload.py └── 07-linking-between-sites │ ├── Makefile │ ├── _build │ ├── doctrees │ │ ├── about_us.doctree │ │ ├── environment.pickle │ │ └── index.doctree │ └── html │ │ ├── _downloads │ │ └── 26f0333ad80ad765dabb1115dde48966 │ │ │ └── python-logo.png │ │ ├── _images │ │ └── python-logo.png │ │ ├── _sources │ │ ├── about_us.md.txt │ │ ├── index.md.txt │ │ └── index.rst.txt │ │ ├── _static │ │ ├── alabaster.css │ │ ├── basic.css │ │ ├── custom.css │ │ ├── doctools.js │ │ ├── documentation_options.js │ │ ├── file.png │ │ ├── jquery-3.5.1.js │ │ ├── jquery.js │ │ ├── language_data.js │ │ ├── minus.png │ │ ├── plus.png │ │ ├── pygments.css │ │ ├── searchtools.js │ │ ├── underscore-1.13.1.js │ │ └── underscore.js │ │ ├── about_us.html │ │ ├── genindex.html │ │ ├── index.html │ │ ├── objects.inv │ │ ├── search.html │ │ └── searchindex.js │ ├── about_us.md │ ├── conf.py │ ├── index.md │ ├── make.bat │ ├── my_demo.py │ ├── python-logo.png │ ├── requirements.txt │ └── run_livereload.py └── readme_resources └── sphinx-course.png /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Talk Python 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Static Sites with Sphinx and Markdown course 2 | 3 | 4 | 5 | Welcome to the course repository for Static Sites with Sphinx and Markdown from Talk Python Training, in parternship with JetBrains. 6 | 7 | You'll find the code and other materials from the course. If you aren't yet registered, learn about the course and sign up at [Talk Python Training](https://training.talkpython.fm/courses/static-sites-with-sphinx-and-markdown). 8 | 9 | [![](./readme_resources/sphinx-course.png)](https://training.talkpython.fm/courses/static-sites-with-sphinx-and-markdown) 10 | 11 | -------------------------------------------------------------------------------- /code/02-setup/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /code/02-setup/_build/doctrees/about_us.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/02-setup/_build/doctrees/about_us.doctree -------------------------------------------------------------------------------- /code/02-setup/_build/doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/02-setup/_build/doctrees/environment.pickle -------------------------------------------------------------------------------- /code/02-setup/_build/doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/02-setup/_build/doctrees/index.doctree -------------------------------------------------------------------------------- /code/02-setup/_build/html/_sources/about_us.md.txt: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | -------------------------------------------------------------------------------- /code/02-setup/_build/html/_sources/index.rst.txt: -------------------------------------------------------------------------------- 1 | Schlockchain Homepage 2 | ===================== 3 | 4 | Welcome to the future. 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | :caption: Contents: 9 | 10 | about_us -------------------------------------------------------------------------------- /code/02-setup/_build/html/_static/custom.css: -------------------------------------------------------------------------------- 1 | /* This file intentionally left blank. */ 2 | -------------------------------------------------------------------------------- /code/02-setup/_build/html/_static/doctools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * doctools.js 3 | * ~~~~~~~~~~~ 4 | * 5 | * Sphinx JavaScript utilities for all documentation. 6 | * 7 | * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | /** 13 | * select a different prefix for underscore 14 | */ 15 | $u = _.noConflict(); 16 | 17 | /** 18 | * make the code below compatible with browsers without 19 | * an installed firebug like debugger 20 | if (!window.console || !console.firebug) { 21 | var names = ["log", "debug", "info", "warn", "error", "assert", "dir", 22 | "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", 23 | "profile", "profileEnd"]; 24 | window.console = {}; 25 | for (var i = 0; i < names.length; ++i) 26 | window.console[names[i]] = function() {}; 27 | } 28 | */ 29 | 30 | /** 31 | * small helper function to urldecode strings 32 | * 33 | * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL 34 | */ 35 | jQuery.urldecode = function(x) { 36 | if (!x) { 37 | return x 38 | } 39 | return decodeURIComponent(x.replace(/\+/g, ' ')); 40 | }; 41 | 42 | /** 43 | * small helper function to urlencode strings 44 | */ 45 | jQuery.urlencode = encodeURIComponent; 46 | 47 | /** 48 | * This function returns the parsed url parameters of the 49 | * current request. Multiple values per key are supported, 50 | * it will always return arrays of strings for the value parts. 51 | */ 52 | jQuery.getQueryParameters = function(s) { 53 | if (typeof s === 'undefined') 54 | s = document.location.search; 55 | var parts = s.substr(s.indexOf('?') + 1).split('&'); 56 | var result = {}; 57 | for (var i = 0; i < parts.length; i++) { 58 | var tmp = parts[i].split('=', 2); 59 | var key = jQuery.urldecode(tmp[0]); 60 | var value = jQuery.urldecode(tmp[1]); 61 | if (key in result) 62 | result[key].push(value); 63 | else 64 | result[key] = [value]; 65 | } 66 | return result; 67 | }; 68 | 69 | /** 70 | * highlight a given string on a jquery object by wrapping it in 71 | * span elements with the given class name. 72 | */ 73 | jQuery.fn.highlightText = function(text, className) { 74 | function highlight(node, addItems) { 75 | if (node.nodeType === 3) { 76 | var val = node.nodeValue; 77 | var pos = val.toLowerCase().indexOf(text); 78 | if (pos >= 0 && 79 | !jQuery(node.parentNode).hasClass(className) && 80 | !jQuery(node.parentNode).hasClass("nohighlight")) { 81 | var span; 82 | var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); 83 | if (isInSVG) { 84 | span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); 85 | } else { 86 | span = document.createElement("span"); 87 | span.className = className; 88 | } 89 | span.appendChild(document.createTextNode(val.substr(pos, text.length))); 90 | node.parentNode.insertBefore(span, node.parentNode.insertBefore( 91 | document.createTextNode(val.substr(pos + text.length)), 92 | node.nextSibling)); 93 | node.nodeValue = val.substr(0, pos); 94 | if (isInSVG) { 95 | var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); 96 | var bbox = node.parentElement.getBBox(); 97 | rect.x.baseVal.value = bbox.x; 98 | rect.y.baseVal.value = bbox.y; 99 | rect.width.baseVal.value = bbox.width; 100 | rect.height.baseVal.value = bbox.height; 101 | rect.setAttribute('class', className); 102 | addItems.push({ 103 | "parent": node.parentNode, 104 | "target": rect}); 105 | } 106 | } 107 | } 108 | else if (!jQuery(node).is("button, select, textarea")) { 109 | jQuery.each(node.childNodes, function() { 110 | highlight(this, addItems); 111 | }); 112 | } 113 | } 114 | var addItems = []; 115 | var result = this.each(function() { 116 | highlight(this, addItems); 117 | }); 118 | for (var i = 0; i < addItems.length; ++i) { 119 | jQuery(addItems[i].parent).before(addItems[i].target); 120 | } 121 | return result; 122 | }; 123 | 124 | /* 125 | * backward compatibility for jQuery.browser 126 | * This will be supported until firefox bug is fixed. 127 | */ 128 | if (!jQuery.browser) { 129 | jQuery.uaMatch = function(ua) { 130 | ua = ua.toLowerCase(); 131 | 132 | var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || 133 | /(webkit)[ \/]([\w.]+)/.exec(ua) || 134 | /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || 135 | /(msie) ([\w.]+)/.exec(ua) || 136 | ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || 137 | []; 138 | 139 | return { 140 | browser: match[ 1 ] || "", 141 | version: match[ 2 ] || "0" 142 | }; 143 | }; 144 | jQuery.browser = {}; 145 | jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; 146 | } 147 | 148 | /** 149 | * Small JavaScript module for the documentation. 150 | */ 151 | var Documentation = { 152 | 153 | init : function() { 154 | this.fixFirefoxAnchorBug(); 155 | this.highlightSearchWords(); 156 | this.initIndexTable(); 157 | if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { 158 | this.initOnKeyListeners(); 159 | } 160 | }, 161 | 162 | /** 163 | * i18n support 164 | */ 165 | TRANSLATIONS : {}, 166 | PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, 167 | LOCALE : 'unknown', 168 | 169 | // gettext and ngettext don't access this so that the functions 170 | // can safely bound to a different name (_ = Documentation.gettext) 171 | gettext : function(string) { 172 | var translated = Documentation.TRANSLATIONS[string]; 173 | if (typeof translated === 'undefined') 174 | return string; 175 | return (typeof translated === 'string') ? translated : translated[0]; 176 | }, 177 | 178 | ngettext : function(singular, plural, n) { 179 | var translated = Documentation.TRANSLATIONS[singular]; 180 | if (typeof translated === 'undefined') 181 | return (n == 1) ? singular : plural; 182 | return translated[Documentation.PLURALEXPR(n)]; 183 | }, 184 | 185 | addTranslations : function(catalog) { 186 | for (var key in catalog.messages) 187 | this.TRANSLATIONS[key] = catalog.messages[key]; 188 | this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); 189 | this.LOCALE = catalog.locale; 190 | }, 191 | 192 | /** 193 | * add context elements like header anchor links 194 | */ 195 | addContextElements : function() { 196 | $('div[id] > :header:first').each(function() { 197 | $('\u00B6'). 198 | attr('href', '#' + this.id). 199 | attr('title', _('Permalink to this headline')). 200 | appendTo(this); 201 | }); 202 | $('dt[id]').each(function() { 203 | $('\u00B6'). 204 | attr('href', '#' + this.id). 205 | attr('title', _('Permalink to this definition')). 206 | appendTo(this); 207 | }); 208 | }, 209 | 210 | /** 211 | * workaround a firefox stupidity 212 | * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 213 | */ 214 | fixFirefoxAnchorBug : function() { 215 | if (document.location.hash && $.browser.mozilla) 216 | window.setTimeout(function() { 217 | document.location.href += ''; 218 | }, 10); 219 | }, 220 | 221 | /** 222 | * highlight the search words provided in the url in the text 223 | */ 224 | highlightSearchWords : function() { 225 | var params = $.getQueryParameters(); 226 | var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; 227 | if (terms.length) { 228 | var body = $('div.body'); 229 | if (!body.length) { 230 | body = $('body'); 231 | } 232 | window.setTimeout(function() { 233 | $.each(terms, function() { 234 | body.highlightText(this.toLowerCase(), 'highlighted'); 235 | }); 236 | }, 10); 237 | $('

' + _('Hide Search Matches') + '

') 239 | .appendTo($('#searchbox')); 240 | } 241 | }, 242 | 243 | /** 244 | * init the domain index toggle buttons 245 | */ 246 | initIndexTable : function() { 247 | var togglers = $('img.toggler').click(function() { 248 | var src = $(this).attr('src'); 249 | var idnum = $(this).attr('id').substr(7); 250 | $('tr.cg-' + idnum).toggle(); 251 | if (src.substr(-9) === 'minus.png') 252 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 253 | else 254 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 255 | }).css('display', ''); 256 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 257 | togglers.click(); 258 | } 259 | }, 260 | 261 | /** 262 | * helper function to hide the search marks again 263 | */ 264 | hideSearchWords : function() { 265 | $('#searchbox .highlight-link').fadeOut(300); 266 | $('span.highlighted').removeClass('highlighted'); 267 | }, 268 | 269 | /** 270 | * make the url absolute 271 | */ 272 | makeURL : function(relativeURL) { 273 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 274 | }, 275 | 276 | /** 277 | * get the current relative url 278 | */ 279 | getCurrentURL : function() { 280 | var path = document.location.pathname; 281 | var parts = path.split(/\//); 282 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 283 | if (this === '..') 284 | parts.pop(); 285 | }); 286 | var url = parts.join('/'); 287 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 288 | }, 289 | 290 | initOnKeyListeners: function() { 291 | $(document).keydown(function(event) { 292 | var activeElementType = document.activeElement.tagName; 293 | // don't navigate when in search box, textarea, dropdown or button 294 | if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' 295 | && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey 296 | && !event.shiftKey) { 297 | switch (event.keyCode) { 298 | case 37: // left 299 | var prevHref = $('link[rel="prev"]').prop('href'); 300 | if (prevHref) { 301 | window.location.href = prevHref; 302 | return false; 303 | } 304 | break; 305 | case 39: // right 306 | var nextHref = $('link[rel="next"]').prop('href'); 307 | if (nextHref) { 308 | window.location.href = nextHref; 309 | return false; 310 | } 311 | break; 312 | } 313 | } 314 | }); 315 | } 316 | }; 317 | 318 | // quick alias for translations 319 | _ = Documentation.gettext; 320 | 321 | $(document).ready(function() { 322 | Documentation.init(); 323 | }); 324 | -------------------------------------------------------------------------------- /code/02-setup/_build/html/_static/documentation_options.js: -------------------------------------------------------------------------------- 1 | var DOCUMENTATION_OPTIONS = { 2 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), 3 | VERSION: '', 4 | LANGUAGE: 'None', 5 | COLLAPSE_INDEX: false, 6 | BUILDER: 'html', 7 | FILE_SUFFIX: '.html', 8 | LINK_SUFFIX: '.html', 9 | HAS_SOURCE: true, 10 | SOURCELINK_SUFFIX: '.txt', 11 | NAVIGATION_WITH_KEYS: false 12 | }; -------------------------------------------------------------------------------- /code/02-setup/_build/html/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/02-setup/_build/html/_static/file.png -------------------------------------------------------------------------------- /code/02-setup/_build/html/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/02-setup/_build/html/_static/minus.png -------------------------------------------------------------------------------- /code/02-setup/_build/html/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/02-setup/_build/html/_static/plus.png -------------------------------------------------------------------------------- /code/02-setup/_build/html/_static/pygments.css: -------------------------------------------------------------------------------- 1 | pre { line-height: 125%; } 2 | td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 3 | span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 4 | td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 6 | .highlight .hll { background-color: #ffffcc } 7 | .highlight { background: #f8f8f8; } 8 | .highlight .c { color: #8f5902; font-style: italic } /* Comment */ 9 | .highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ 10 | .highlight .g { color: #000000 } /* Generic */ 11 | .highlight .k { color: #004461; font-weight: bold } /* Keyword */ 12 | .highlight .l { color: #000000 } /* Literal */ 13 | .highlight .n { color: #000000 } /* Name */ 14 | .highlight .o { color: #582800 } /* Operator */ 15 | .highlight .x { color: #000000 } /* Other */ 16 | .highlight .p { color: #000000; font-weight: bold } /* Punctuation */ 17 | .highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ 18 | .highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ 19 | .highlight .cp { color: #8f5902 } /* Comment.Preproc */ 20 | .highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ 21 | .highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ 22 | .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ 23 | .highlight .gd { color: #a40000 } /* Generic.Deleted */ 24 | .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ 25 | .highlight .gr { color: #ef2929 } /* Generic.Error */ 26 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 27 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 28 | .highlight .go { color: #888888 } /* Generic.Output */ 29 | .highlight .gp { color: #745334 } /* Generic.Prompt */ 30 | .highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ 31 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 32 | .highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ 33 | .highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ 34 | .highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ 35 | .highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ 36 | .highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ 37 | .highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ 38 | .highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ 39 | .highlight .ld { color: #000000 } /* Literal.Date */ 40 | .highlight .m { color: #990000 } /* Literal.Number */ 41 | .highlight .s { color: #4e9a06 } /* Literal.String */ 42 | .highlight .na { color: #c4a000 } /* Name.Attribute */ 43 | .highlight .nb { color: #004461 } /* Name.Builtin */ 44 | .highlight .nc { color: #000000 } /* Name.Class */ 45 | .highlight .no { color: #000000 } /* Name.Constant */ 46 | .highlight .nd { color: #888888 } /* Name.Decorator */ 47 | .highlight .ni { color: #ce5c00 } /* Name.Entity */ 48 | .highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ 49 | .highlight .nf { color: #000000 } /* Name.Function */ 50 | .highlight .nl { color: #f57900 } /* Name.Label */ 51 | .highlight .nn { color: #000000 } /* Name.Namespace */ 52 | .highlight .nx { color: #000000 } /* Name.Other */ 53 | .highlight .py { color: #000000 } /* Name.Property */ 54 | .highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ 55 | .highlight .nv { color: #000000 } /* Name.Variable */ 56 | .highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ 57 | .highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ 58 | .highlight .mb { color: #990000 } /* Literal.Number.Bin */ 59 | .highlight .mf { color: #990000 } /* Literal.Number.Float */ 60 | .highlight .mh { color: #990000 } /* Literal.Number.Hex */ 61 | .highlight .mi { color: #990000 } /* Literal.Number.Integer */ 62 | .highlight .mo { color: #990000 } /* Literal.Number.Oct */ 63 | .highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ 64 | .highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ 65 | .highlight .sc { color: #4e9a06 } /* Literal.String.Char */ 66 | .highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ 67 | .highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ 68 | .highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ 69 | .highlight .se { color: #4e9a06 } /* Literal.String.Escape */ 70 | .highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ 71 | .highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ 72 | .highlight .sx { color: #4e9a06 } /* Literal.String.Other */ 73 | .highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ 74 | .highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ 75 | .highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ 76 | .highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ 77 | .highlight .fm { color: #000000 } /* Name.Function.Magic */ 78 | .highlight .vc { color: #000000 } /* Name.Variable.Class */ 79 | .highlight .vg { color: #000000 } /* Name.Variable.Global */ 80 | .highlight .vi { color: #000000 } /* Name.Variable.Instance */ 81 | .highlight .vm { color: #000000 } /* Name.Variable.Magic */ 82 | .highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /code/02-setup/_build/html/about_us.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | About Us — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

About Us

37 |

We are Schlockchain, thought leaders in innovation.

38 |
39 | 40 | 41 |
42 | 43 |
44 |
45 | 90 |
91 |
92 |
93 | ©2021, Paul Everitt . 94 | 95 | | 96 | Powered by Sphinx 4.3.2 97 | & Alabaster 0.7.12 98 | 99 | | 100 | Page source 102 |
103 | 104 | 105 | 106 | 107 | 108 | -------------------------------------------------------------------------------- /code/02-setup/_build/html/genindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Index — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 |
29 | 30 | 31 |
32 | 33 | 34 |

Index

35 | 36 |
37 | 38 |
39 | 40 | 41 |
42 | 43 |
44 |
45 | 89 |
90 |
91 |
92 | ©2021, Paul Everitt . 93 | 94 | | 95 | Powered by Sphinx 4.3.2 96 | & Alabaster 0.7.12 97 | 98 |
99 | 100 | 101 | 102 | 103 | 104 | -------------------------------------------------------------------------------- /code/02-setup/_build/html/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Schlockchain Homepage — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

Schlockchain Homepage

37 |

Welcome to the future.

38 |
39 |

Contents:

40 | 43 |
44 |
45 | 46 | 47 |
48 | 49 |
50 |
51 | 96 |
97 |
98 |
99 | ©2021, Paul Everitt . 100 | 101 | | 102 | Powered by Sphinx 4.3.2 103 | & Alabaster 0.7.12 104 | 105 | | 106 | Page source 108 |
109 | 110 | 111 | 112 | 113 | 114 | -------------------------------------------------------------------------------- /code/02-setup/_build/html/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/02-setup/_build/html/objects.inv -------------------------------------------------------------------------------- /code/02-setup/_build/html/search.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Search — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 |
33 |
34 |
35 | 36 | 37 |
38 | 39 |

Search

40 | 41 | 49 | 50 | 51 |

52 | Searching for multiple words only shows matches that contain 53 | all words. 54 |

55 | 56 | 57 |
58 | 59 | 60 | 61 |
62 | 63 | 64 | 65 |
66 | 67 |
68 | 69 | 70 |
71 | 72 |
73 |
74 | 108 |
109 |
110 |
111 | ©2021, Paul Everitt . 112 | 113 | | 114 | Powered by Sphinx 4.3.2 115 | & Alabaster 0.7.12 116 | 117 |
118 | 119 | 120 | 121 | 122 | 123 | -------------------------------------------------------------------------------- /code/02-setup/_build/html/searchindex.js: -------------------------------------------------------------------------------- 1 | Search.setIndex({docnames:["about_us","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["about_us.md","index.rst"],objects:{},objnames:{},objtypes:{},terms:{about:1,ar:0,futur:1,index:[],innov:0,leader:0,modul:[],page:[],schlockchain:0,search:[],thought:0,us:1,we:0,welcom:1},titles:["About Us","Schlockchain Homepage"],titleterms:{about:0,content:1,document:[],homepag:1,indic:[],s:[],schlockchain:1,tabl:[],us:0,welcom:[]}}) -------------------------------------------------------------------------------- /code/02-setup/about_us.md: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | -------------------------------------------------------------------------------- /code/02-setup/conf.py: -------------------------------------------------------------------------------- 1 | project = "Schlockchain" 2 | copyright = "2021, Paul Everitt " 3 | author = "Paul Everitt " 4 | extensions = [ 5 | "myst_parser", 6 | ] 7 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"] 8 | html_static_path = ["_static"] 9 | templates_path = ["_templates"] 10 | -------------------------------------------------------------------------------- /code/02-setup/index.md: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | ```{toctree} 6 | :maxdepth: 2 7 | :caption: "Contents:" 8 | 9 | about_us 10 | ``` 11 | -------------------------------------------------------------------------------- /code/02-setup/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=. 11 | set BUILDDIR=_build 12 | 13 | if "%1" == "" goto help 14 | 15 | %SPHINXBUILD% >NUL 2>NUL 16 | if errorlevel 9009 ( 17 | echo. 18 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 19 | echo.installed, then set the SPHINXBUILD environment variable to point 20 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 21 | echo.may add the Sphinx directory to PATH. 22 | echo. 23 | echo.If you don't have Sphinx installed, grab it from 24 | echo.https://www.sphinx-doc.org/ 25 | exit /b 1 26 | ) 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /code/02-setup/requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx 2 | livereload 3 | myst-parser 4 | -------------------------------------------------------------------------------- /code/02-setup/run_livereload.py: -------------------------------------------------------------------------------- 1 | from livereload import Server, shell 2 | 3 | if __name__ == '__main__': 4 | server = Server() 5 | server.watch('*.rst', shell('make html'), delay=1) 6 | server.watch('*.md', shell('make html'), delay=1) 7 | server.watch('*.py', shell('make html'), delay=1) 8 | server.watch('_static/*', shell('make html'), delay=1) 9 | server.watch('_templates/*', shell('make html'), delay=1) 10 | server.serve(root='_build/html') 11 | -------------------------------------------------------------------------------- /code/03-simple-markdown/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/doctrees/about_us.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/03-simple-markdown/_build/doctrees/about_us.doctree -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/03-simple-markdown/_build/doctrees/environment.pickle -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/03-simple-markdown/_build/doctrees/index.doctree -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_images/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/03-simple-markdown/_build/html/_images/python-logo.png -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_sources/about_us.md.txt: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ![Python Logo](python-logo.png) 45 | -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_sources/index.md.txt: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | ```{toctree} 6 | :maxdepth: 2 7 | :caption: "Contents:" 8 | 9 | about_us 10 | ``` 11 | -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_sources/index.rst.txt: -------------------------------------------------------------------------------- 1 | Schlockchain Homepage 2 | ===================== 3 | 4 | Welcome to the future. 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | :caption: Contents: 9 | 10 | about_us -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_static/custom.css: -------------------------------------------------------------------------------- 1 | /* This file intentionally left blank. */ 2 | -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_static/documentation_options.js: -------------------------------------------------------------------------------- 1 | var DOCUMENTATION_OPTIONS = { 2 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), 3 | VERSION: '', 4 | LANGUAGE: 'None', 5 | COLLAPSE_INDEX: false, 6 | BUILDER: 'html', 7 | FILE_SUFFIX: '.html', 8 | LINK_SUFFIX: '.html', 9 | HAS_SOURCE: true, 10 | SOURCELINK_SUFFIX: '.txt', 11 | NAVIGATION_WITH_KEYS: false 12 | }; -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/03-simple-markdown/_build/html/_static/file.png -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/03-simple-markdown/_build/html/_static/minus.png -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/03-simple-markdown/_build/html/_static/plus.png -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/_static/pygments.css: -------------------------------------------------------------------------------- 1 | pre { line-height: 125%; } 2 | td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 3 | span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 4 | td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 6 | .highlight .hll { background-color: #ffffcc } 7 | .highlight { background: #f8f8f8; } 8 | .highlight .c { color: #8f5902; font-style: italic } /* Comment */ 9 | .highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ 10 | .highlight .g { color: #000000 } /* Generic */ 11 | .highlight .k { color: #004461; font-weight: bold } /* Keyword */ 12 | .highlight .l { color: #000000 } /* Literal */ 13 | .highlight .n { color: #000000 } /* Name */ 14 | .highlight .o { color: #582800 } /* Operator */ 15 | .highlight .x { color: #000000 } /* Other */ 16 | .highlight .p { color: #000000; font-weight: bold } /* Punctuation */ 17 | .highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ 18 | .highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ 19 | .highlight .cp { color: #8f5902 } /* Comment.Preproc */ 20 | .highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ 21 | .highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ 22 | .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ 23 | .highlight .gd { color: #a40000 } /* Generic.Deleted */ 24 | .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ 25 | .highlight .gr { color: #ef2929 } /* Generic.Error */ 26 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 27 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 28 | .highlight .go { color: #888888 } /* Generic.Output */ 29 | .highlight .gp { color: #745334 } /* Generic.Prompt */ 30 | .highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ 31 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 32 | .highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ 33 | .highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ 34 | .highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ 35 | .highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ 36 | .highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ 37 | .highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ 38 | .highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ 39 | .highlight .ld { color: #000000 } /* Literal.Date */ 40 | .highlight .m { color: #990000 } /* Literal.Number */ 41 | .highlight .s { color: #4e9a06 } /* Literal.String */ 42 | .highlight .na { color: #c4a000 } /* Name.Attribute */ 43 | .highlight .nb { color: #004461 } /* Name.Builtin */ 44 | .highlight .nc { color: #000000 } /* Name.Class */ 45 | .highlight .no { color: #000000 } /* Name.Constant */ 46 | .highlight .nd { color: #888888 } /* Name.Decorator */ 47 | .highlight .ni { color: #ce5c00 } /* Name.Entity */ 48 | .highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ 49 | .highlight .nf { color: #000000 } /* Name.Function */ 50 | .highlight .nl { color: #f57900 } /* Name.Label */ 51 | .highlight .nn { color: #000000 } /* Name.Namespace */ 52 | .highlight .nx { color: #000000 } /* Name.Other */ 53 | .highlight .py { color: #000000 } /* Name.Property */ 54 | .highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ 55 | .highlight .nv { color: #000000 } /* Name.Variable */ 56 | .highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ 57 | .highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ 58 | .highlight .mb { color: #990000 } /* Literal.Number.Bin */ 59 | .highlight .mf { color: #990000 } /* Literal.Number.Float */ 60 | .highlight .mh { color: #990000 } /* Literal.Number.Hex */ 61 | .highlight .mi { color: #990000 } /* Literal.Number.Integer */ 62 | .highlight .mo { color: #990000 } /* Literal.Number.Oct */ 63 | .highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ 64 | .highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ 65 | .highlight .sc { color: #4e9a06 } /* Literal.String.Char */ 66 | .highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ 67 | .highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ 68 | .highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ 69 | .highlight .se { color: #4e9a06 } /* Literal.String.Escape */ 70 | .highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ 71 | .highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ 72 | .highlight .sx { color: #4e9a06 } /* Literal.String.Other */ 73 | .highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ 74 | .highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ 75 | .highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ 76 | .highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ 77 | .highlight .fm { color: #000000 } /* Name.Function.Magic */ 78 | .highlight .vc { color: #000000 } /* Name.Variable.Class */ 79 | .highlight .vg { color: #000000 } /* Name.Variable.Global */ 80 | .highlight .vi { color: #000000 } /* Name.Variable.Instance */ 81 | .highlight .vm { color: #000000 } /* Name.Variable.Magic */ 82 | .highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/about_us.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | About Us — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

About Us

37 |

We are Schlockchain, thought leaders in innovation.

38 |

We are bold and innovative.

39 |

Our def mega_chain function works really well:

40 | 
def mega_chain(): return
 41 |
42 |
43 |

Investors say the best things about us:

44 |
45 |

I’m so glad I put my life savings in Schlockchain.

46 |
47 |

Said Nobody Ever

48 |
49 |
50 |

We have a patented algorithm:

51 |
    52 |

  • Glacially slow

    • 53 |

  • Which melts glaciers

    • 54 |
55 |

…and a roadmap to success:

56 |
    57 |

  1. Start an LLC

    2. 58 |

  2. Get a Series A investment round

    3. 59 |

  3. Get a Series B investment round

    4. 60 |

  4. Continue

    5. 61 |
62 |

Schlockchain is written in Python for some 63 | data science or something reasons.

64 |

For a sexy carousel of stock photos, visit Schlockchain Homepage.

65 |
66 |

Investors

67 |

Our investors are very proud to be involved with us.

68 |
69 |
70 |

Redacted

71 |

Upon advice of counsel.

72 |
73 |
74 |

Redacted

75 |

Upon advice of counsel.

76 |

Python Logo

77 |
78 |
79 | 80 | 81 |
82 | 83 |
84 |
85 | 135 |
136 |
137 |
138 | ©2021, Paul Everitt . 139 | 140 | | 141 | Powered by Sphinx 4.3.2 142 | & Alabaster 0.7.12 143 | 144 | | 145 | Page source 147 |
148 | 149 | 150 | 151 | 152 | 153 | -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/genindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Index — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 |
29 | 30 | 31 |
32 | 33 | 34 |

Index

35 | 36 |
37 | 38 |
39 | 40 | 41 |
42 | 43 |
44 |
45 | 89 |
90 |
91 |
92 | ©2021, Paul Everitt . 93 | 94 | | 95 | Powered by Sphinx 4.3.2 96 | & Alabaster 0.7.12 97 | 98 |
99 | 100 | 101 | 102 | 103 | 104 | -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Schlockchain Homepage — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

Schlockchain Homepage

37 |

Welcome to the future.

38 |
39 |

Contents:

40 | 48 |
49 |
50 | 51 | 52 |
53 | 54 |
55 |
56 | 101 |
102 |
103 |
104 | ©2021, Paul Everitt . 105 | 106 | | 107 | Powered by Sphinx 4.3.2 108 | & Alabaster 0.7.12 109 | 110 | | 111 | Page source 113 |
114 | 115 | 116 | 117 | 118 | 119 | -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/03-simple-markdown/_build/html/objects.inv -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/search.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Search — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 |
33 |
34 |
35 | 36 | 37 |
38 | 39 |

Search

40 | 41 | 49 | 50 | 51 |

52 | Searching for multiple words only shows matches that contain 53 | all words. 54 |

55 | 56 | 57 |
58 | 59 | 60 | 61 |
62 | 63 | 64 | 65 |
66 | 67 |
68 | 69 | 70 |
71 | 72 |
73 |
74 | 108 |
109 |
110 |
111 | ©2021, Paul Everitt . 112 | 113 | | 114 | Powered by Sphinx 4.3.2 115 | & Alabaster 0.7.12 116 | 117 |
118 | 119 | 120 | 121 | 122 | 123 | -------------------------------------------------------------------------------- /code/03-simple-markdown/_build/html/searchindex.js: -------------------------------------------------------------------------------- 1 | Search.setIndex({docnames:["about_us","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["about_us.md","index.md"],objects:{},objnames:{},objtypes:{},terms:{"function":0,"return":0,A:0,For:0,about:1,advic:0,algorithm:0,an:0,ar:0,b:0,best:0,bold:0,carousel:0,continu:0,counsel:0,data:0,def:0,ever:0,futur:1,get:0,glacial:0,glacier:0,glad:0,have:0,homepag:0,i:0,index:[],innov:0,invest:0,investor:1,involv:0,leader:0,life:0,llc:0,m:0,mega_chain:0,melt:0,modul:[],my:0,nobodi:0,our:0,page:[],patent:0,photo:0,proud:0,put:0,python:0,realli:0,reason:0,redact:1,roadmap:0,round:0,s:[],sai:0,said:0,save:0,schlockchain:0,scienc:0,search:[],seri:0,sexi:0,site:[],slow:0,so:0,some:0,someth:0,start:0,stock:0,success:0,thi:[],thing:0,thought:0,upon:0,us:1,veri:0,visit:0,we:0,welcom:1,well:0,which:0,work:0,written:0},titles:["About Us","Schlockchain Homepage"],titleterms:{about:0,content:1,document:[],homepag:1,indic:[],investor:0,redact:0,s:[],schlockchain:1,tabl:[],us:0,welcom:[]}}) -------------------------------------------------------------------------------- /code/03-simple-markdown/about_us.md: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ![Python Logo](python-logo.png) 45 | -------------------------------------------------------------------------------- /code/03-simple-markdown/conf.py: -------------------------------------------------------------------------------- 1 | project = "Schlockchain" 2 | copyright = "2021, Paul Everitt " 3 | author = "Paul Everitt " 4 | extensions = [ 5 | "myst_parser", 6 | ] 7 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"] 8 | html_static_path = ["_static"] 9 | templates_path = ["_templates"] 10 | -------------------------------------------------------------------------------- /code/03-simple-markdown/index.md: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | ```{toctree} 6 | :maxdepth: 2 7 | :caption: "Contents:" 8 | 9 | about_us 10 | ``` 11 | -------------------------------------------------------------------------------- /code/03-simple-markdown/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=. 11 | set BUILDDIR=_build 12 | 13 | if "%1" == "" goto help 14 | 15 | %SPHINXBUILD% >NUL 2>NUL 16 | if errorlevel 9009 ( 17 | echo. 18 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 19 | echo.installed, then set the SPHINXBUILD environment variable to point 20 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 21 | echo.may add the Sphinx directory to PATH. 22 | echo. 23 | echo.If you don't have Sphinx installed, grab it from 24 | echo.https://www.sphinx-doc.org/ 25 | exit /b 1 26 | ) 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /code/03-simple-markdown/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/03-simple-markdown/python-logo.png -------------------------------------------------------------------------------- /code/03-simple-markdown/requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx 2 | livereload 3 | myst-parser 4 | -------------------------------------------------------------------------------- /code/03-simple-markdown/run_livereload.py: -------------------------------------------------------------------------------- 1 | from livereload import Server, shell 2 | 3 | if __name__ == '__main__': 4 | server = Server() 5 | server.watch('*.rst', shell('make html'), delay=1) 6 | server.watch('*.md', shell('make html'), delay=1) 7 | server.watch('*.py', shell('make html'), delay=1) 8 | server.watch('_static/*', shell('make html'), delay=1) 9 | server.watch('_templates/*', shell('make html'), delay=1) 10 | server.serve(root='_build/html') 11 | -------------------------------------------------------------------------------- /code/04-more-authoring/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /code/04-more-authoring/_build/doctrees/about_us.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/_build/doctrees/about_us.doctree -------------------------------------------------------------------------------- /code/04-more-authoring/_build/doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/_build/doctrees/environment.pickle -------------------------------------------------------------------------------- /code/04-more-authoring/_build/doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/_build/doctrees/index.doctree -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_downloads/26f0333ad80ad765dabb1115dde48966/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/_build/html/_downloads/26f0333ad80ad765dabb1115dde48966/python-logo.png -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_images/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/_build/html/_images/python-logo.png -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_sources/about_us.md.txt: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ```{image} python-logo.png 45 | :alt: Python Logo 46 | :class: bg-primary 47 | :width: 200px 48 | :align: center 49 | ``` 50 | 51 | :::{figure-md} logo-target 52 | :class: myclass 53 | 54 | Python Logo 55 | 56 | Python comes from the *Python Software Foundation*. 57 | ::: 58 | 59 | ```{note} 60 | Schlockchain is written in [Python](https://www.python.org/) for 61 | some data science or something reasons. 62 | ``` 63 | 64 | ```{warning} 65 | Schlockchain is written in [Python](https://www.python.org/) for 66 | some data science or something reasons. 67 | 68 | - Careful, Python is *awesome* 69 | - Using it will thus make you *awesome* 70 | ``` 71 | 72 | :::{warning} Awesomeness Warning 73 | 74 | Schlockchain is written in [Python](https://www.python.org/) for 75 | some data science or something reasons. 76 | 77 | - Careful, Python is *awesome* 78 | - Using it will thus make you *awesome* 79 | ::: 80 | 81 | You can {download}`download the Python logo ` for offline use. 82 | -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_sources/index.md.txt: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | The logo is at {ref}`the Python logo `. 6 | 7 | ```{toctree} 8 | --- 9 | maxdepth: 1 10 | caption: | 11 | Contents: 12 | glob: 13 | --- 14 | 15 | * 16 | ``` 17 | -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_sources/index.rst.txt: -------------------------------------------------------------------------------- 1 | Schlockchain Homepage 2 | ===================== 3 | 4 | Welcome to the future. 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | :caption: Contents: 9 | 10 | about_us -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_static/custom.css: -------------------------------------------------------------------------------- 1 | /* This file intentionally left blank. */ 2 | -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_static/documentation_options.js: -------------------------------------------------------------------------------- 1 | var DOCUMENTATION_OPTIONS = { 2 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), 3 | VERSION: '', 4 | LANGUAGE: 'None', 5 | COLLAPSE_INDEX: false, 6 | BUILDER: 'html', 7 | FILE_SUFFIX: '.html', 8 | LINK_SUFFIX: '.html', 9 | HAS_SOURCE: true, 10 | SOURCELINK_SUFFIX: '.txt', 11 | NAVIGATION_WITH_KEYS: false 12 | }; -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/_build/html/_static/file.png -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/_build/html/_static/minus.png -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/_build/html/_static/plus.png -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/_static/pygments.css: -------------------------------------------------------------------------------- 1 | pre { line-height: 125%; } 2 | td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 3 | span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 4 | td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 6 | .highlight .hll { background-color: #ffffcc } 7 | .highlight { background: #f8f8f8; } 8 | .highlight .c { color: #8f5902; font-style: italic } /* Comment */ 9 | .highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ 10 | .highlight .g { color: #000000 } /* Generic */ 11 | .highlight .k { color: #004461; font-weight: bold } /* Keyword */ 12 | .highlight .l { color: #000000 } /* Literal */ 13 | .highlight .n { color: #000000 } /* Name */ 14 | .highlight .o { color: #582800 } /* Operator */ 15 | .highlight .x { color: #000000 } /* Other */ 16 | .highlight .p { color: #000000; font-weight: bold } /* Punctuation */ 17 | .highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ 18 | .highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ 19 | .highlight .cp { color: #8f5902 } /* Comment.Preproc */ 20 | .highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ 21 | .highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ 22 | .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ 23 | .highlight .gd { color: #a40000 } /* Generic.Deleted */ 24 | .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ 25 | .highlight .gr { color: #ef2929 } /* Generic.Error */ 26 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 27 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 28 | .highlight .go { color: #888888 } /* Generic.Output */ 29 | .highlight .gp { color: #745334 } /* Generic.Prompt */ 30 | .highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ 31 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 32 | .highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ 33 | .highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ 34 | .highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ 35 | .highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ 36 | .highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ 37 | .highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ 38 | .highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ 39 | .highlight .ld { color: #000000 } /* Literal.Date */ 40 | .highlight .m { color: #990000 } /* Literal.Number */ 41 | .highlight .s { color: #4e9a06 } /* Literal.String */ 42 | .highlight .na { color: #c4a000 } /* Name.Attribute */ 43 | .highlight .nb { color: #004461 } /* Name.Builtin */ 44 | .highlight .nc { color: #000000 } /* Name.Class */ 45 | .highlight .no { color: #000000 } /* Name.Constant */ 46 | .highlight .nd { color: #888888 } /* Name.Decorator */ 47 | .highlight .ni { color: #ce5c00 } /* Name.Entity */ 48 | .highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ 49 | .highlight .nf { color: #000000 } /* Name.Function */ 50 | .highlight .nl { color: #f57900 } /* Name.Label */ 51 | .highlight .nn { color: #000000 } /* Name.Namespace */ 52 | .highlight .nx { color: #000000 } /* Name.Other */ 53 | .highlight .py { color: #000000 } /* Name.Property */ 54 | .highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ 55 | .highlight .nv { color: #000000 } /* Name.Variable */ 56 | .highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ 57 | .highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ 58 | .highlight .mb { color: #990000 } /* Literal.Number.Bin */ 59 | .highlight .mf { color: #990000 } /* Literal.Number.Float */ 60 | .highlight .mh { color: #990000 } /* Literal.Number.Hex */ 61 | .highlight .mi { color: #990000 } /* Literal.Number.Integer */ 62 | .highlight .mo { color: #990000 } /* Literal.Number.Oct */ 63 | .highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ 64 | .highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ 65 | .highlight .sc { color: #4e9a06 } /* Literal.String.Char */ 66 | .highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ 67 | .highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ 68 | .highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ 69 | .highlight .se { color: #4e9a06 } /* Literal.String.Escape */ 70 | .highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ 71 | .highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ 72 | .highlight .sx { color: #4e9a06 } /* Literal.String.Other */ 73 | .highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ 74 | .highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ 75 | .highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ 76 | .highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ 77 | .highlight .fm { color: #000000 } /* Name.Function.Magic */ 78 | .highlight .vc { color: #000000 } /* Name.Variable.Class */ 79 | .highlight .vg { color: #000000 } /* Name.Variable.Global */ 80 | .highlight .vi { color: #000000 } /* Name.Variable.Instance */ 81 | .highlight .vm { color: #000000 } /* Name.Variable.Magic */ 82 | .highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/about_us.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | About Us — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

About Us

37 |

We are Schlockchain, thought leaders in innovation.

38 |

We are bold and innovative.

39 |

Our def mega_chain function works really well:

40 | 
def mega_chain(): return
 41 |
42 |
43 |

Investors say the best things about us:

44 |
45 |

I’m so glad I put my life savings in Schlockchain.

46 |
47 |

Said Nobody Ever

48 |
49 |
50 |

We have a patented algorithm:

51 |
    52 |

  • Glacially slow

    • 53 |

  • Which melts glaciers

    • 54 |
55 |

…and a roadmap to success:

56 |
    57 |

  1. Start an LLC

    2. 58 |

  2. Get a Series A investment round

    3. 59 |

  3. Get a Series B investment round

    4. 60 |

  4. Continue

    5. 61 |
62 |

Schlockchain is written in Python for some 63 | data science or something reasons.

64 |

For a sexy carousel of stock photos, visit Schlockchain Homepage.

65 |
66 |

Investors

67 |

Our investors are very proud to be involved with us.

68 |
69 |
70 |

Redacted

71 |

Upon advice of counsel.

72 |
73 |
74 |

Redacted

75 |

Upon advice of counsel.

76 | Python Logo 77 |
78 | Python Logo 79 |
80 |

Python comes from the Python Software Foundation.

81 |
82 |
83 |
84 |

Note

85 |

Schlockchain is written in Python for 86 | some data science or something reasons.

87 |
88 |
89 |

Warning

90 |

Schlockchain is written in Python for 91 | some data science or something reasons.

92 |
    93 |

  • Careful, Python is awesome

    • 94 |

  • Using it will thus make you awesome

    • 95 |
96 |
97 |
98 |

Warning

99 |

Awesomeness Warning

100 |

Schlockchain is written in Python for 101 | some data science or something reasons.

102 |
    103 |

  • Careful, Python is awesome

    • 104 |

  • Using it will thus make you awesome

    • 105 |
106 |
107 |

You can download the Python logo for offline use.

108 |
109 |
110 | 111 | 112 |
113 | 114 |
115 |
116 | 162 |
163 |
164 |
165 | ©2021, Paul Everitt . 166 | 167 | | 168 | Powered by Sphinx 4.3.2 169 | & Alabaster 0.7.12 170 | 171 | | 172 | Page source 174 |
175 | 176 | 177 | 178 | 179 | 180 | -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/genindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Index — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 |
29 | 30 | 31 |
32 | 33 | 34 |

Index

35 | 36 |
37 | 38 |
39 | 40 | 41 |
42 | 43 |
44 |
45 | 90 |
91 |
92 |
93 | ©2021, Paul Everitt . 94 | 95 | | 96 | Powered by Sphinx 4.3.2 97 | & Alabaster 0.7.12 98 | 99 |
100 | 101 | 102 | 103 | 104 | 105 | -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Schlockchain Homepage — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

Schlockchain Homepage

37 |

Welcome to the future.

38 |

The logo is at the Python logo.

39 |
40 |

Contents: 41 |

42 | 45 |
46 |
47 | 48 | 49 |
50 | 51 |
52 |
53 | 99 |
100 |
101 |
102 | ©2021, Paul Everitt . 103 | 104 | | 105 | Powered by Sphinx 4.3.2 106 | & Alabaster 0.7.12 107 | 108 | | 109 | Page source 111 |
112 | 113 | 114 | 115 | 116 | 117 | -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/_build/html/objects.inv -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/search.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Search — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 |
33 |
34 |
35 | 36 | 37 |
38 | 39 |

Search

40 | 41 | 49 | 50 | 51 |

52 | Searching for multiple words only shows matches that contain 53 | all words. 54 |

55 | 56 | 57 |
58 | 59 | 60 | 61 |
62 | 63 | 64 | 65 |
66 | 67 |
68 | 69 | 70 |
71 | 72 |
73 |
74 | 109 |
110 |
111 |
112 | ©2021, Paul Everitt . 113 | 114 | | 115 | Powered by Sphinx 4.3.2 116 | & Alabaster 0.7.12 117 | 118 |
119 | 120 | 121 | 122 | 123 | 124 | -------------------------------------------------------------------------------- /code/04-more-authoring/_build/html/searchindex.js: -------------------------------------------------------------------------------- 1 | Search.setIndex({docnames:["about_us","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["about_us.md","index.md"],objects:{},objnames:{},objtypes:{},terms:{"function":0,"return":0,A:0,For:0,The:1,about:1,advic:0,algorithm:0,an:0,ar:0,awesom:0,b:0,best:0,bold:0,can:0,care:0,carousel:0,come:0,continu:0,counsel:0,data:0,def:0,download:0,ever:0,foundat:0,from:0,futur:1,get:0,glacial:0,glacier:0,glad:0,have:0,homepag:0,i:0,index:[],innov:0,invest:0,investor:[],involv:0,leader:0,life:0,llc:0,logo:[0,1],m:0,make:0,mega_chain:0,melt:0,modul:[],my:0,nobodi:0,offlin:0,our:0,page:[],patent:0,photo:0,png:[],proud:0,put:0,python:[0,1],realli:0,reason:0,redact:[],roadmap:0,round:0,s:[],sai:0,said:0,save:0,schlockchain:0,scienc:0,search:[],second:[],seri:0,sexi:0,site:[],slow:0,so:0,softwar:0,some:0,someth:0,start:0,stock:0,success:0,thi:[],thing:0,thought:0,thu:0,upon:0,us:1,veri:0,visit:0,warn:0,we:0,welcom:1,well:0,which:0,work:0,written:0,you:0},titles:["About Us","Schlockchain Homepage"],titleterms:{about:0,content:1,document:[],homepag:1,indic:[],investor:0,redact:0,s:[],schlockchain:1,tabl:[],us:0,welcom:[]}}) -------------------------------------------------------------------------------- /code/04-more-authoring/about_us.md: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ```{image} python-logo.png 45 | :alt: Python Logo 46 | :class: bg-primary 47 | :width: 200px 48 | :align: center 49 | ``` 50 | 51 | :::{figure-md} logo-target 52 | :class: myclass 53 | 54 | Python Logo 55 | 56 | Python comes from the *Python Software Foundation*. 57 | ::: 58 | 59 | ```{note} 60 | Schlockchain is written in [Python](https://www.python.org/) for 61 | some data science or something reasons. 62 | ``` 63 | 64 | ```{warning} 65 | Schlockchain is written in [Python](https://www.python.org/) for 66 | some data science or something reasons. 67 | 68 | - Careful, Python is *awesome* 69 | - Using it will thus make you *awesome* 70 | ``` 71 | 72 | :::{warning} Awesomeness Warning 73 | 74 | Schlockchain is written in [Python](https://www.python.org/) for 75 | some data science or something reasons. 76 | 77 | - Careful, Python is *awesome* 78 | - Using it will thus make you *awesome* 79 | ::: 80 | 81 | You can {download}`download the Python logo ` for offline use. 82 | -------------------------------------------------------------------------------- /code/04-more-authoring/conf.py: -------------------------------------------------------------------------------- 1 | project = "Schlockchain" 2 | copyright = "2021, Paul Everitt " 3 | author = "Paul Everitt " 4 | extensions = [ 5 | "myst_parser", 6 | ] 7 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"] 8 | html_static_path = ["_static"] 9 | templates_path = ["_templates"] 10 | myst_enable_extensions = [ 11 | "colon_fence", 12 | ] 13 | -------------------------------------------------------------------------------- /code/04-more-authoring/index.md: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | The logo is at {ref}`the Python logo `. 6 | 7 | ```{toctree} 8 | --- 9 | maxdepth: 1 10 | caption: | 11 | Contents: 12 | glob: 13 | --- 14 | 15 | * 16 | ``` 17 | -------------------------------------------------------------------------------- /code/04-more-authoring/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=. 11 | set BUILDDIR=_build 12 | 13 | if "%1" == "" goto help 14 | 15 | %SPHINXBUILD% >NUL 2>NUL 16 | if errorlevel 9009 ( 17 | echo. 18 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 19 | echo.installed, then set the SPHINXBUILD environment variable to point 20 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 21 | echo.may add the Sphinx directory to PATH. 22 | echo. 23 | echo.If you don't have Sphinx installed, grab it from 24 | echo.https://www.sphinx-doc.org/ 25 | exit /b 1 26 | ) 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /code/04-more-authoring/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/04-more-authoring/python-logo.png -------------------------------------------------------------------------------- /code/04-more-authoring/requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx 2 | livereload 3 | myst-parser 4 | -------------------------------------------------------------------------------- /code/04-more-authoring/run_livereload.py: -------------------------------------------------------------------------------- 1 | from livereload import Server, shell 2 | 3 | if __name__ == '__main__': 4 | server = Server() 5 | server.watch('*.rst', shell('make html'), delay=1) 6 | server.watch('*.md', shell('make html'), delay=1) 7 | server.watch('*.py', shell('make html'), delay=1) 8 | server.watch('_static/*', shell('make html'), delay=1) 9 | server.watch('_templates/*', shell('make html'), delay=1) 10 | server.serve(root='_build/html') 11 | -------------------------------------------------------------------------------- /code/05-linking/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /code/05-linking/_build/doctrees/about_us.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/_build/doctrees/about_us.doctree -------------------------------------------------------------------------------- /code/05-linking/_build/doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/_build/doctrees/environment.pickle -------------------------------------------------------------------------------- /code/05-linking/_build/doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/_build/doctrees/index.doctree -------------------------------------------------------------------------------- /code/05-linking/_build/html/_downloads/26f0333ad80ad765dabb1115dde48966/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/_build/html/_downloads/26f0333ad80ad765dabb1115dde48966/python-logo.png -------------------------------------------------------------------------------- /code/05-linking/_build/html/_images/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/_build/html/_images/python-logo.png -------------------------------------------------------------------------------- /code/05-linking/_build/html/_sources/about_us.md.txt: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ```{image} python-logo.png 45 | :alt: Python Logo 46 | :class: bg-primary 47 | :width: 200px 48 | :align: center 49 | ``` 50 | 51 | :::{figure-md} logo-target 52 | :class: myclass 53 | 54 | Python Logo 55 | 56 | Python comes from the *Python Software Foundation*. 57 | ::: 58 | 59 | ```{note} 60 | Schlockchain is written in [Python](https://www.python.org/) for 61 | some data science or something reasons. 62 | ``` 63 | 64 | ```{warning} 65 | Schlockchain is written in [Python](https://www.python.org/) for 66 | some data science or something reasons. 67 | 68 | - Careful, Python is *awesome* 69 | - Using it will thus make you *awesome* 70 | ``` 71 | 72 | :::{warning} Awesomeness Warning 73 | 74 | Schlockchain is written in [Python](https://www.python.org/) for 75 | some data science or something reasons. 76 | 77 | - Careful, Python is *awesome* 78 | - Using it will thus make you *awesome* 79 | ::: 80 | 81 | You can {download}`download the Python logo ` for offline use. 82 | 83 | (investors)= 84 | ## Investors 85 | 86 | Our investors are very proud to be involved with us. 87 | -------------------------------------------------------------------------------- /code/05-linking/_build/html/_sources/index.md.txt: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | The logo is at {ref}`the Python logo `. 6 | 7 | More information about Schlockchain is available in [](about_us). 8 | 9 | You can also visit our {ref}`investors`. 10 | 11 | ```{toctree} 12 | --- 13 | maxdepth: 1 14 | caption: | 15 | Contents: 16 | glob: 17 | --- 18 | 19 | * 20 | ``` 21 | -------------------------------------------------------------------------------- /code/05-linking/_build/html/_sources/index.rst.txt: -------------------------------------------------------------------------------- 1 | Schlockchain Homepage 2 | ===================== 3 | 4 | Welcome to the future. 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | :caption: Contents: 9 | 10 | about_us -------------------------------------------------------------------------------- /code/05-linking/_build/html/_static/custom.css: -------------------------------------------------------------------------------- 1 | /* This file intentionally left blank. */ 2 | -------------------------------------------------------------------------------- /code/05-linking/_build/html/_static/documentation_options.js: -------------------------------------------------------------------------------- 1 | var DOCUMENTATION_OPTIONS = { 2 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), 3 | VERSION: '', 4 | LANGUAGE: 'None', 5 | COLLAPSE_INDEX: false, 6 | BUILDER: 'html', 7 | FILE_SUFFIX: '.html', 8 | LINK_SUFFIX: '.html', 9 | HAS_SOURCE: true, 10 | SOURCELINK_SUFFIX: '.txt', 11 | NAVIGATION_WITH_KEYS: false 12 | }; -------------------------------------------------------------------------------- /code/05-linking/_build/html/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/_build/html/_static/file.png -------------------------------------------------------------------------------- /code/05-linking/_build/html/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/_build/html/_static/minus.png -------------------------------------------------------------------------------- /code/05-linking/_build/html/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/_build/html/_static/plus.png -------------------------------------------------------------------------------- /code/05-linking/_build/html/_static/pygments.css: -------------------------------------------------------------------------------- 1 | pre { line-height: 125%; } 2 | td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 3 | span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 4 | td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 6 | .highlight .hll { background-color: #ffffcc } 7 | .highlight { background: #f8f8f8; } 8 | .highlight .c { color: #8f5902; font-style: italic } /* Comment */ 9 | .highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ 10 | .highlight .g { color: #000000 } /* Generic */ 11 | .highlight .k { color: #004461; font-weight: bold } /* Keyword */ 12 | .highlight .l { color: #000000 } /* Literal */ 13 | .highlight .n { color: #000000 } /* Name */ 14 | .highlight .o { color: #582800 } /* Operator */ 15 | .highlight .x { color: #000000 } /* Other */ 16 | .highlight .p { color: #000000; font-weight: bold } /* Punctuation */ 17 | .highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ 18 | .highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ 19 | .highlight .cp { color: #8f5902 } /* Comment.Preproc */ 20 | .highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ 21 | .highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ 22 | .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ 23 | .highlight .gd { color: #a40000 } /* Generic.Deleted */ 24 | .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ 25 | .highlight .gr { color: #ef2929 } /* Generic.Error */ 26 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 27 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 28 | .highlight .go { color: #888888 } /* Generic.Output */ 29 | .highlight .gp { color: #745334 } /* Generic.Prompt */ 30 | .highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ 31 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 32 | .highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ 33 | .highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ 34 | .highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ 35 | .highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ 36 | .highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ 37 | .highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ 38 | .highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ 39 | .highlight .ld { color: #000000 } /* Literal.Date */ 40 | .highlight .m { color: #990000 } /* Literal.Number */ 41 | .highlight .s { color: #4e9a06 } /* Literal.String */ 42 | .highlight .na { color: #c4a000 } /* Name.Attribute */ 43 | .highlight .nb { color: #004461 } /* Name.Builtin */ 44 | .highlight .nc { color: #000000 } /* Name.Class */ 45 | .highlight .no { color: #000000 } /* Name.Constant */ 46 | .highlight .nd { color: #888888 } /* Name.Decorator */ 47 | .highlight .ni { color: #ce5c00 } /* Name.Entity */ 48 | .highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ 49 | .highlight .nf { color: #000000 } /* Name.Function */ 50 | .highlight .nl { color: #f57900 } /* Name.Label */ 51 | .highlight .nn { color: #000000 } /* Name.Namespace */ 52 | .highlight .nx { color: #000000 } /* Name.Other */ 53 | .highlight .py { color: #000000 } /* Name.Property */ 54 | .highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ 55 | .highlight .nv { color: #000000 } /* Name.Variable */ 56 | .highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ 57 | .highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ 58 | .highlight .mb { color: #990000 } /* Literal.Number.Bin */ 59 | .highlight .mf { color: #990000 } /* Literal.Number.Float */ 60 | .highlight .mh { color: #990000 } /* Literal.Number.Hex */ 61 | .highlight .mi { color: #990000 } /* Literal.Number.Integer */ 62 | .highlight .mo { color: #990000 } /* Literal.Number.Oct */ 63 | .highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ 64 | .highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ 65 | .highlight .sc { color: #4e9a06 } /* Literal.String.Char */ 66 | .highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ 67 | .highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ 68 | .highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ 69 | .highlight .se { color: #4e9a06 } /* Literal.String.Escape */ 70 | .highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ 71 | .highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ 72 | .highlight .sx { color: #4e9a06 } /* Literal.String.Other */ 73 | .highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ 74 | .highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ 75 | .highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ 76 | .highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ 77 | .highlight .fm { color: #000000 } /* Name.Function.Magic */ 78 | .highlight .vc { color: #000000 } /* Name.Variable.Class */ 79 | .highlight .vg { color: #000000 } /* Name.Variable.Global */ 80 | .highlight .vi { color: #000000 } /* Name.Variable.Instance */ 81 | .highlight .vm { color: #000000 } /* Name.Variable.Magic */ 82 | .highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /code/05-linking/_build/html/about_us.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | About Us — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

About Us

37 |

We are Schlockchain, thought leaders in innovation.

38 |

We are bold and innovative.

39 |

Our def mega_chain function works really well:

40 | 
def mega_chain(): return
 41 |
42 |
43 |

Investors say the best things about us:

44 |
45 |

I’m so glad I put my life savings in Schlockchain.

46 |
47 |

Said Nobody Ever

48 |
49 |
50 |

We have a patented algorithm:

51 |
    52 |

  • Glacially slow

    • 53 |

  • Which melts glaciers

    • 54 |
55 |

…and a roadmap to success:

56 |
    57 |

  1. Start an LLC

    2. 58 |

  2. Get a Series A investment round

    3. 59 |

  3. Get a Series B investment round

    4. 60 |

  4. Continue

    5. 61 |
62 |

Schlockchain is written in Python for some 63 | data science or something reasons.

64 |

For a sexy carousel of stock photos, visit Schlockchain Homepage.

65 |
66 |

Investors

67 |

Our investors are very proud to be involved with us.

68 |
69 |
70 |

Redacted

71 |

Upon advice of counsel.

72 |
73 |
74 |

Redacted

75 |

Upon advice of counsel.

76 | Python Logo 77 |
78 | Python Logo 79 |
80 |

Python comes from the Python Software Foundation.

81 |
82 |
83 |
84 |

Note

85 |

Schlockchain is written in Python for 86 | some data science or something reasons.

87 |
88 |
89 |

Warning

90 |

Schlockchain is written in Python for 91 | some data science or something reasons.

92 |
    93 |

  • Careful, Python is awesome

    • 94 |

  • Using it will thus make you awesome

    • 95 |
96 |
97 |
98 |

Warning

99 |

Awesomeness Warning

100 |

Schlockchain is written in Python for 101 | some data science or something reasons.

102 |
    103 |

  • Careful, Python is awesome

    • 104 |

  • Using it will thus make you awesome

    • 105 |
106 |
107 |

You can download the Python logo for offline use.

108 |
109 |
110 |

Investors

111 |

Our investors are very proud to be involved with us.

112 |
113 |
114 | 115 | 116 |
117 | 118 |
119 |
120 | 166 |
167 |
168 |
169 | ©2021, Paul Everitt . 170 | 171 | | 172 | Powered by Sphinx 4.3.2 173 | & Alabaster 0.7.12 174 | 175 | | 176 | Page source 178 |
179 | 180 | 181 | 182 | 183 | 184 | -------------------------------------------------------------------------------- /code/05-linking/_build/html/genindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Index — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 |
29 | 30 | 31 |
32 | 33 | 34 |

Index

35 | 36 |
37 | 38 |
39 | 40 | 41 |
42 | 43 |
44 |
45 | 90 |
91 |
92 |
93 | ©2021, Paul Everitt . 94 | 95 | | 96 | Powered by Sphinx 4.3.2 97 | & Alabaster 0.7.12 98 | 99 |
100 | 101 | 102 | 103 | 104 | 105 | -------------------------------------------------------------------------------- /code/05-linking/_build/html/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Schlockchain Homepage — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

Schlockchain Homepage

37 |

Welcome to the future.

38 |

The logo is at the Python logo.

39 |

More information about Schlockchain is available in About Us.

40 |

You can also visit our Investors.

41 |
42 |

Contents: 43 |

44 | 47 |
48 |
49 | 50 | 51 |
52 | 53 |
54 |
55 | 101 |
102 |
103 |
104 | ©2021, Paul Everitt . 105 | 106 | | 107 | Powered by Sphinx 4.3.2 108 | & Alabaster 0.7.12 109 | 110 | | 111 | Page source 113 |
114 | 115 | 116 | 117 | 118 | 119 | -------------------------------------------------------------------------------- /code/05-linking/_build/html/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/_build/html/objects.inv -------------------------------------------------------------------------------- /code/05-linking/_build/html/search.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Search — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 |
33 |
34 |
35 | 36 | 37 |
38 | 39 |

Search

40 | 41 | 49 | 50 | 51 |

52 | Searching for multiple words only shows matches that contain 53 | all words. 54 |

55 | 56 | 57 |
58 | 59 | 60 | 61 |
62 | 63 | 64 | 65 |
66 | 67 |
68 | 69 | 70 |
71 | 72 |
73 |
74 | 109 |
110 |
111 |
112 | ©2021, Paul Everitt . 113 | 114 | | 115 | Powered by Sphinx 4.3.2 116 | & Alabaster 0.7.12 117 | 118 |
119 | 120 | 121 | 122 | 123 | 124 | -------------------------------------------------------------------------------- /code/05-linking/_build/html/searchindex.js: -------------------------------------------------------------------------------- 1 | Search.setIndex({docnames:["about_us","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["about_us.md","index.md"],objects:{},objnames:{},objtypes:{},terms:{"function":0,"return":0,A:0,For:0,The:1,about:1,advic:0,algorithm:0,also:1,an:0,ar:0,avail:1,awesom:0,b:0,best:0,bold:0,can:[0,1],care:0,carousel:0,come:0,continu:0,counsel:0,data:0,def:0,download:0,ever:0,foundat:0,from:0,futur:1,get:0,glacial:0,glacier:0,glad:0,have:0,homepag:0,i:0,index:[],inform:1,innov:0,invest:0,investor:1,involv:0,leader:0,life:0,llc:0,logo:[0,1],m:0,make:0,mega_chain:0,melt:0,modul:[],more:1,my:0,nobodi:0,offlin:0,our:[0,1],page:[],patent:0,photo:0,png:[],proud:0,put:0,python:[0,1],realli:0,reason:0,redact:[],roadmap:0,round:0,s:[],sai:0,said:0,save:0,schlockchain:0,scienc:0,search:[],second:[],seri:0,sexi:0,site:[],slow:0,so:0,softwar:0,some:0,someth:0,start:0,stock:0,success:0,thi:[],thing:0,thought:0,thu:0,upon:0,us:1,veri:0,visit:[0,1],warn:0,we:0,welcom:1,well:0,which:0,work:0,written:0,you:[0,1]},titles:["About Us","Schlockchain Homepage"],titleterms:{about:0,content:1,document:[],homepag:1,indic:[],investor:0,redact:0,s:[],schlockchain:1,tabl:[],us:0,welcom:[]}}) -------------------------------------------------------------------------------- /code/05-linking/about_us.md: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ```{image} python-logo.png 45 | :alt: Python Logo 46 | :class: bg-primary 47 | :width: 200px 48 | :align: center 49 | ``` 50 | 51 | :::{figure-md} logo-target 52 | :class: myclass 53 | 54 | Python Logo 55 | 56 | Python comes from the *Python Software Foundation*. 57 | ::: 58 | 59 | ```{note} 60 | Schlockchain is written in [Python](https://www.python.org/) for 61 | some data science or something reasons. 62 | ``` 63 | 64 | ```{warning} 65 | Schlockchain is written in [Python](https://www.python.org/) for 66 | some data science or something reasons. 67 | 68 | - Careful, Python is *awesome* 69 | - Using it will thus make you *awesome* 70 | ``` 71 | 72 | :::{warning} Awesomeness Warning 73 | 74 | Schlockchain is written in [Python](https://www.python.org/) for 75 | some data science or something reasons. 76 | 77 | - Careful, Python is *awesome* 78 | - Using it will thus make you *awesome* 79 | ::: 80 | 81 | You can {download}`download the Python logo ` for offline use. 82 | 83 | (investors)= 84 | ## Investors 85 | 86 | Our investors are very proud to be involved with us. 87 | -------------------------------------------------------------------------------- /code/05-linking/conf.py: -------------------------------------------------------------------------------- 1 | project = "Schlockchain" 2 | copyright = "2021, Paul Everitt " 3 | author = "Paul Everitt " 4 | extensions = [ 5 | "myst_parser", 6 | ] 7 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"] 8 | html_static_path = ["_static"] 9 | templates_path = ["_templates"] 10 | myst_enable_extensions = [ 11 | "colon_fence", 12 | ] 13 | -------------------------------------------------------------------------------- /code/05-linking/index.md: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | The logo is at {ref}`the Python logo `. 6 | 7 | More information about Schlockchain is available in [](about_us). 8 | 9 | You can also visit our {ref}`investors`. 10 | 11 | ```{toctree} 12 | --- 13 | maxdepth: 1 14 | caption: | 15 | Contents: 16 | glob: 17 | --- 18 | 19 | * 20 | ``` 21 | -------------------------------------------------------------------------------- /code/05-linking/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=. 11 | set BUILDDIR=_build 12 | 13 | if "%1" == "" goto help 14 | 15 | %SPHINXBUILD% >NUL 2>NUL 16 | if errorlevel 9009 ( 17 | echo. 18 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 19 | echo.installed, then set the SPHINXBUILD environment variable to point 20 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 21 | echo.may add the Sphinx directory to PATH. 22 | echo. 23 | echo.If you don't have Sphinx installed, grab it from 24 | echo.https://www.sphinx-doc.org/ 25 | exit /b 1 26 | ) 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /code/05-linking/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/05-linking/python-logo.png -------------------------------------------------------------------------------- /code/05-linking/requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx 2 | livereload 3 | myst-parser 4 | -------------------------------------------------------------------------------- /code/05-linking/run_livereload.py: -------------------------------------------------------------------------------- 1 | from livereload import Server, shell 2 | 3 | if __name__ == '__main__': 4 | server = Server() 5 | server.watch('*.rst', shell('make html'), delay=1) 6 | server.watch('*.md', shell('make html'), delay=1) 7 | server.watch('*.py', shell('make html'), delay=1) 8 | server.watch('_static/*', shell('make html'), delay=1) 9 | server.watch('_templates/*', shell('make html'), delay=1) 10 | server.serve(root='_build/html') 11 | -------------------------------------------------------------------------------- /code/06-documenting-code/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /code/06-documenting-code/_build/doctrees/about_us.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/_build/doctrees/about_us.doctree -------------------------------------------------------------------------------- /code/06-documenting-code/_build/doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/_build/doctrees/environment.pickle -------------------------------------------------------------------------------- /code/06-documenting-code/_build/doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/_build/doctrees/index.doctree -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_downloads/26f0333ad80ad765dabb1115dde48966/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/_build/html/_downloads/26f0333ad80ad765dabb1115dde48966/python-logo.png -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_images/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/_build/html/_images/python-logo.png -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_sources/about_us.md.txt: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ```{image} python-logo.png 45 | :alt: Python Logo 46 | :class: bg-primary 47 | :width: 200px 48 | :align: center 49 | ``` 50 | 51 | :::{figure-md} logo-target 52 | :class: myclass 53 | 54 | Python Logo 55 | 56 | Python comes from the *Python Software Foundation*. 57 | ::: 58 | 59 | ```{note} 60 | Schlockchain is written in [Python](https://www.python.org/) for 61 | some data science or something reasons. 62 | ``` 63 | 64 | ```{warning} 65 | Schlockchain is written in [Python](https://www.python.org/) for 66 | some data science or something reasons. 67 | 68 | - Careful, Python is *awesome* 69 | - Using it will thus make you *awesome* 70 | ``` 71 | 72 | :::{warning} Awesomeness Warning 73 | 74 | Schlockchain is written in [Python](https://www.python.org/) for 75 | some data science or something reasons. 76 | 77 | - Careful, Python is *awesome* 78 | - Using it will thus make you *awesome* 79 | ::: 80 | 81 | You can {download}`download the Python logo ` for offline use. 82 | 83 | (investors)= 84 | ## Investors 85 | 86 | Our investors are very proud to be involved with us. 87 | 88 | ``` 89 | def hello(name): 90 | return f'Hello {name}' 91 | ``` 92 | 93 | ```{code-block} javascript 94 | --- 95 | linenos: true 96 | emphasize-lines: 2 97 | --- 98 | function hello(msg) { 99 | return `Hello ${msg}` 100 | } 101 | ``` 102 | 103 | ```{literalinclude} my_demo.py 104 | --- 105 | emphasize-lines: 2-3 106 | --- 107 | ``` 108 | 109 | # About `MyDemo` 110 | 111 | Let's take a look at this Python class. 112 | 113 | ```{eval-rst} 114 | .. autoclass:: my_demo.MyDemo 115 | :members: 116 | ``` 117 | 118 | As we can see in {py:class}`HW `, Python is fun! 119 | 120 | -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_sources/index.md.txt: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | The logo is at {ref}`the Python logo `. 6 | 7 | More information about Schlockchain is available in [](about_us). 8 | 9 | You can also visit our {ref}`investors`. 10 | 11 | ```{toctree} 12 | --- 13 | maxdepth: 1 14 | caption: | 15 | Contents: 16 | glob: 17 | --- 18 | 19 | * 20 | ``` 21 | -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_sources/index.rst.txt: -------------------------------------------------------------------------------- 1 | Schlockchain Homepage 2 | ===================== 3 | 4 | Welcome to the future. 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | :caption: Contents: 9 | 10 | about_us -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_static/custom.css: -------------------------------------------------------------------------------- 1 | /* This file intentionally left blank. */ 2 | -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_static/documentation_options.js: -------------------------------------------------------------------------------- 1 | var DOCUMENTATION_OPTIONS = { 2 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), 3 | VERSION: '', 4 | LANGUAGE: 'None', 5 | COLLAPSE_INDEX: false, 6 | BUILDER: 'html', 7 | FILE_SUFFIX: '.html', 8 | LINK_SUFFIX: '.html', 9 | HAS_SOURCE: true, 10 | SOURCELINK_SUFFIX: '.txt', 11 | NAVIGATION_WITH_KEYS: false 12 | }; -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/_build/html/_static/file.png -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/_build/html/_static/minus.png -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/_build/html/_static/plus.png -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/_static/pygments.css: -------------------------------------------------------------------------------- 1 | pre { line-height: 125%; } 2 | td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 3 | span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 4 | td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 6 | .highlight .hll { background-color: #ffffcc } 7 | .highlight { background: #f8f8f8; } 8 | .highlight .c { color: #8f5902; font-style: italic } /* Comment */ 9 | .highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ 10 | .highlight .g { color: #000000 } /* Generic */ 11 | .highlight .k { color: #004461; font-weight: bold } /* Keyword */ 12 | .highlight .l { color: #000000 } /* Literal */ 13 | .highlight .n { color: #000000 } /* Name */ 14 | .highlight .o { color: #582800 } /* Operator */ 15 | .highlight .x { color: #000000 } /* Other */ 16 | .highlight .p { color: #000000; font-weight: bold } /* Punctuation */ 17 | .highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ 18 | .highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ 19 | .highlight .cp { color: #8f5902 } /* Comment.Preproc */ 20 | .highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ 21 | .highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ 22 | .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ 23 | .highlight .gd { color: #a40000 } /* Generic.Deleted */ 24 | .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ 25 | .highlight .gr { color: #ef2929 } /* Generic.Error */ 26 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 27 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 28 | .highlight .go { color: #888888 } /* Generic.Output */ 29 | .highlight .gp { color: #745334 } /* Generic.Prompt */ 30 | .highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ 31 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 32 | .highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ 33 | .highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ 34 | .highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ 35 | .highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ 36 | .highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ 37 | .highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ 38 | .highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ 39 | .highlight .ld { color: #000000 } /* Literal.Date */ 40 | .highlight .m { color: #990000 } /* Literal.Number */ 41 | .highlight .s { color: #4e9a06 } /* Literal.String */ 42 | .highlight .na { color: #c4a000 } /* Name.Attribute */ 43 | .highlight .nb { color: #004461 } /* Name.Builtin */ 44 | .highlight .nc { color: #000000 } /* Name.Class */ 45 | .highlight .no { color: #000000 } /* Name.Constant */ 46 | .highlight .nd { color: #888888 } /* Name.Decorator */ 47 | .highlight .ni { color: #ce5c00 } /* Name.Entity */ 48 | .highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ 49 | .highlight .nf { color: #000000 } /* Name.Function */ 50 | .highlight .nl { color: #f57900 } /* Name.Label */ 51 | .highlight .nn { color: #000000 } /* Name.Namespace */ 52 | .highlight .nx { color: #000000 } /* Name.Other */ 53 | .highlight .py { color: #000000 } /* Name.Property */ 54 | .highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ 55 | .highlight .nv { color: #000000 } /* Name.Variable */ 56 | .highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ 57 | .highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ 58 | .highlight .mb { color: #990000 } /* Literal.Number.Bin */ 59 | .highlight .mf { color: #990000 } /* Literal.Number.Float */ 60 | .highlight .mh { color: #990000 } /* Literal.Number.Hex */ 61 | .highlight .mi { color: #990000 } /* Literal.Number.Integer */ 62 | .highlight .mo { color: #990000 } /* Literal.Number.Oct */ 63 | .highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ 64 | .highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ 65 | .highlight .sc { color: #4e9a06 } /* Literal.String.Char */ 66 | .highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ 67 | .highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ 68 | .highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ 69 | .highlight .se { color: #4e9a06 } /* Literal.String.Escape */ 70 | .highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ 71 | .highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ 72 | .highlight .sx { color: #4e9a06 } /* Literal.String.Other */ 73 | .highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ 74 | .highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ 75 | .highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ 76 | .highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ 77 | .highlight .fm { color: #000000 } /* Name.Function.Magic */ 78 | .highlight .vc { color: #000000 } /* Name.Variable.Class */ 79 | .highlight .vg { color: #000000 } /* Name.Variable.Global */ 80 | .highlight .vi { color: #000000 } /* Name.Variable.Instance */ 81 | .highlight .vm { color: #000000 } /* Name.Variable.Magic */ 82 | .highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/genindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Index — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 |
29 | 30 | 31 |
32 | 33 | 34 |

Index

35 | 36 |
37 | H 38 | | M 39 | 40 |
41 |

H

42 | 43 | 47 |
48 | 49 |

M

50 | 51 | 55 |
56 | 57 | 58 | 59 |
60 | 61 |
62 |
63 | 109 |
110 |
111 |
112 | ©2021, Paul Everitt . 113 | 114 | | 115 | Powered by Sphinx 4.3.2 116 | & Alabaster 0.7.12 117 | 118 |
119 | 120 | 121 | 122 | 123 | 124 | -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Schlockchain Homepage — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

Schlockchain Homepage

37 |

Welcome to the future.

38 |

The logo is at the Python logo.

39 |

More information about Schlockchain is available in About Us.

40 |

You can also visit our Investors.

41 |
42 |

Contents: 43 |

44 | 48 |
49 |
50 | 51 | 52 |
53 | 54 |
55 |
56 | 103 |
104 |
105 |
106 | ©2021, Paul Everitt . 107 | 108 | | 109 | Powered by Sphinx 4.3.2 110 | & Alabaster 0.7.12 111 | 112 | | 113 | Page source 115 |
116 | 117 | 118 | 119 | 120 | 121 | -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/_build/html/objects.inv -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/search.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Search — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 |
33 |
34 |
35 | 36 | 37 |
38 | 39 |

Search

40 | 41 | 49 | 50 | 51 |

52 | Searching for multiple words only shows matches that contain 53 | all words. 54 |

55 | 56 | 57 |
58 | 59 | 60 | 61 |
62 | 63 | 64 | 65 |
66 | 67 |
68 | 69 | 70 |
71 | 72 |
73 |
74 | 110 |
111 |
112 |
113 | ©2021, Paul Everitt . 114 | 115 | | 116 | Powered by Sphinx 4.3.2 117 | & Alabaster 0.7.12 118 | 119 |
120 | 121 | 122 | 123 | 124 | 125 | -------------------------------------------------------------------------------- /code/06-documenting-code/_build/html/searchindex.js: -------------------------------------------------------------------------------- 1 | Search.setIndex({docnames:["about_us","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["about_us.md","index.md"],objects:{"my_demo.MyDemo":[[0,1,1,"","hello"]],my_demo:[[0,0,1,"","MyDemo"]]},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"class":0,"function":0,"return":0,A:0,As:0,Be:[],For:0,The:[0,1],__init__:0,about:1,advic:0,algorithm:0,also:1,an:0,ar:0,arg:0,avail:1,awesom:0,b:0,best:0,bold:0,can:[0,1],canon:0,care:0,carousel:0,come:0,continu:0,counsel:0,data:0,def:0,demo:0,descript:0,download:0,ever:0,exampl:0,f:0,foundat:0,friendli:[],from:0,fun:0,futur:1,get:0,glacial:0,glacier:0,glad:0,great:0,greet:0,have:0,hello:0,homepag:0,hw:0,i:0,index:[],inform:1,innov:0,invest:0,investor:1,involv:0,leader:0,let:0,life:0,llc:0,logo:[0,1],longer:0,look:0,m:0,make:0,mega_chain:0,melt:0,modul:[],more:1,msg:0,my:0,my_demo:0,mydemo:1,name:0,nobodi:0,offlin:0,our:[0,1],page:[],paramet:0,patent:0,person:0,photo:0,png:[],proud:0,put:0,python:[0,1],realli:0,reason:0,redact:[],roadmap:0,round:0,rst:0,s:0,sai:0,said:0,save:0,schlockchain:0,scienc:0,search:[],second:[],see:0,self:0,seri:0,sexi:0,site:[],slow:0,so:0,softwar:0,some:0,someth:0,start:0,stock:0,str:0,success:0,take:0,thi:0,thing:0,thought:0,thu:0,type:0,upon:0,us:1,veri:0,visit:[0,1],warn:0,we:0,welcom:1,well:0,which:0,work:0,world:0,written:0,you:[0,1]},titles:["About Us","Schlockchain Homepage"],titleterms:{about:0,content:1,document:[],homepag:1,indic:[],investor:0,mydemo:0,redact:0,s:[],schlockchain:1,tabl:[],us:0,welcom:[]}}) -------------------------------------------------------------------------------- /code/06-documenting-code/about_us.md: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ```{image} python-logo.png 45 | :alt: Python Logo 46 | :class: bg-primary 47 | :width: 200px 48 | :align: center 49 | ``` 50 | 51 | :::{figure-md} logo-target 52 | :class: myclass 53 | 54 | Python Logo 55 | 56 | Python comes from the *Python Software Foundation*. 57 | ::: 58 | 59 | ```{note} 60 | Schlockchain is written in [Python](https://www.python.org/) for 61 | some data science or something reasons. 62 | ``` 63 | 64 | ```{warning} 65 | Schlockchain is written in [Python](https://www.python.org/) for 66 | some data science or something reasons. 67 | 68 | - Careful, Python is *awesome* 69 | - Using it will thus make you *awesome* 70 | ``` 71 | 72 | :::{warning} Awesomeness Warning 73 | 74 | Schlockchain is written in [Python](https://www.python.org/) for 75 | some data science or something reasons. 76 | 77 | - Careful, Python is *awesome* 78 | - Using it will thus make you *awesome* 79 | ::: 80 | 81 | You can {download}`download the Python logo ` for offline use. 82 | 83 | (investors)= 84 | ## Investors 85 | 86 | Our investors are very proud to be involved with us. 87 | 88 | ``` 89 | def hello(name): 90 | return f'Hello {name}' 91 | ``` 92 | 93 | ```{code-block} javascript 94 | --- 95 | linenos: true 96 | emphasize-lines: 2 97 | --- 98 | function hello(msg) { 99 | return `Hello ${msg}` 100 | } 101 | ``` 102 | 103 | ```{literalinclude} my_demo.py 104 | --- 105 | emphasize-lines: 2-3 106 | --- 107 | ``` 108 | 109 | # About `MyDemo` 110 | 111 | Let's take a look at this Python class. 112 | 113 | ```{eval-rst} 114 | .. autoclass:: my_demo.MyDemo 115 | :members: 116 | ``` 117 | 118 | As we can see in {py:class}`HW `, Python is fun! 119 | 120 | -------------------------------------------------------------------------------- /code/06-documenting-code/conf.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | sys.path.insert(0, os.path.abspath(".")) 5 | 6 | project = "Schlockchain" 7 | copyright = "2021, Paul Everitt " 8 | author = "Paul Everitt " 9 | extensions = [ 10 | "myst_parser", 11 | "sphinx.ext.autodoc", 12 | "sphinx.ext.napoleon", 13 | "sphinx_autodoc_typehints", 14 | ] 15 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"] 16 | html_static_path = ["_static"] 17 | templates_path = ["_templates"] 18 | myst_enable_extensions = [ 19 | "colon_fence", 20 | ] 21 | -------------------------------------------------------------------------------- /code/06-documenting-code/index.md: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | The logo is at {ref}`the Python logo `. 6 | 7 | More information about Schlockchain is available in [](about_us). 8 | 9 | You can also visit our {ref}`investors`. 10 | 11 | ```{toctree} 12 | --- 13 | maxdepth: 1 14 | caption: | 15 | Contents: 16 | glob: 17 | --- 18 | 19 | * 20 | ``` 21 | -------------------------------------------------------------------------------- /code/06-documenting-code/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=. 11 | set BUILDDIR=_build 12 | 13 | if "%1" == "" goto help 14 | 15 | %SPHINXBUILD% >NUL 2>NUL 16 | if errorlevel 9009 ( 17 | echo. 18 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 19 | echo.installed, then set the SPHINXBUILD environment variable to point 20 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 21 | echo.may add the Sphinx directory to PATH. 22 | echo. 23 | echo.If you don't have Sphinx installed, grab it from 24 | echo.https://www.sphinx-doc.org/ 25 | exit /b 1 26 | ) 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /code/06-documenting-code/my_demo.py: -------------------------------------------------------------------------------- 1 | class MyDemo: 2 | """ A *great* demo """ 3 | 4 | def __init__(self, name): 5 | self.name = name 6 | 7 | def hello(self, greeting: str) -> str: 8 | """ The canonical hello world example. 9 | 10 | A *longer* description with some **RST**. 11 | 12 | Args: 13 | name: The person to say hello to. 14 | Returns: 15 | str: The greeting 16 | """ 17 | return f"{greeting} {self.name}" 18 | -------------------------------------------------------------------------------- /code/06-documenting-code/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/06-documenting-code/python-logo.png -------------------------------------------------------------------------------- /code/06-documenting-code/requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx 2 | livereload 3 | myst-parser 4 | sphinx-autodoc-typehints 5 | -------------------------------------------------------------------------------- /code/06-documenting-code/run_livereload.py: -------------------------------------------------------------------------------- 1 | from livereload import Server, shell 2 | 3 | if __name__ == '__main__': 4 | server = Server() 5 | server.watch('*.rst', shell('make html'), delay=1) 6 | server.watch('*.md', shell('make html'), delay=1) 7 | server.watch('*.py', shell('make html'), delay=1) 8 | server.watch('_static/*', shell('make html'), delay=1) 9 | server.watch('_templates/*', shell('make html'), delay=1) 10 | server.serve(root='_build/html') 11 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/doctrees/about_us.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/_build/doctrees/about_us.doctree -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/_build/doctrees/environment.pickle -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/_build/doctrees/index.doctree -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_downloads/26f0333ad80ad765dabb1115dde48966/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/_build/html/_downloads/26f0333ad80ad765dabb1115dde48966/python-logo.png -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_images/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/_build/html/_images/python-logo.png -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_sources/about_us.md.txt: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ```{image} python-logo.png 45 | :alt: Python Logo 46 | :class: bg-primary 47 | :width: 200px 48 | :align: center 49 | ``` 50 | 51 | :::{figure-md} logo-target 52 | :class: myclass 53 | 54 | Python Logo 55 | 56 | Python comes from the *Python Software Foundation*. 57 | ::: 58 | 59 | ```{note} 60 | Schlockchain is written in [Python](https://www.python.org/) for 61 | some data science or something reasons. 62 | ``` 63 | 64 | ```{warning} 65 | Schlockchain is written in [Python](https://www.python.org/) for 66 | some data science or something reasons. 67 | 68 | - Careful, Python is *awesome* 69 | - Using it will thus make you *awesome* 70 | ``` 71 | 72 | :::{warning} Awesomeness Warning 73 | 74 | Schlockchain is written in [Python](https://www.python.org/) for 75 | some data science or something reasons. 76 | 77 | - Careful, Python is *awesome* 78 | - Using it will thus make you *awesome* 79 | ::: 80 | 81 | You can {download}`download the Python logo ` for offline use. 82 | 83 | (investors)= 84 | ## Investors 85 | 86 | Our investors are very proud to be involved with us. 87 | 88 | ``` 89 | def hello(name): 90 | return f'Hello {name}' 91 | ``` 92 | 93 | ```{code-block} javascript 94 | --- 95 | linenos: true 96 | emphasize-lines: 2 97 | --- 98 | function hello(msg) { 99 | return `Hello ${msg}` 100 | } 101 | ``` 102 | 103 | ```{literalinclude} my_demo.py 104 | --- 105 | emphasize-lines: 2-3 106 | --- 107 | ``` 108 | 109 | # About `MyDemo` 110 | 111 | Let's take a look at this Python class. 112 | 113 | ```{eval-rst} 114 | .. autoclass:: my_demo.MyDemo 115 | :members: 116 | ``` 117 | 118 | As we can see in {py:class}`HW `, Python is fun! 119 | 120 | Let's talk about the power of [](sphinx:ref-role). 121 | 122 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_sources/index.md.txt: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | The logo is at {ref}`the Python logo `. 6 | 7 | More information about Schlockchain is available in [](about_us). 8 | 9 | You can also visit our {ref}`investors`. 10 | 11 | ```{toctree} 12 | --- 13 | maxdepth: 1 14 | caption: | 15 | Contents: 16 | glob: 17 | --- 18 | 19 | * 20 | ``` 21 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_sources/index.rst.txt: -------------------------------------------------------------------------------- 1 | Schlockchain Homepage 2 | ===================== 3 | 4 | Welcome to the future. 5 | 6 | .. toctree:: 7 | :maxdepth: 2 8 | :caption: Contents: 9 | 10 | about_us -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_static/custom.css: -------------------------------------------------------------------------------- 1 | /* This file intentionally left blank. */ 2 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_static/documentation_options.js: -------------------------------------------------------------------------------- 1 | var DOCUMENTATION_OPTIONS = { 2 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), 3 | VERSION: '', 4 | LANGUAGE: 'None', 5 | COLLAPSE_INDEX: false, 6 | BUILDER: 'html', 7 | FILE_SUFFIX: '.html', 8 | LINK_SUFFIX: '.html', 9 | HAS_SOURCE: true, 10 | SOURCELINK_SUFFIX: '.txt', 11 | NAVIGATION_WITH_KEYS: false 12 | }; -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/_build/html/_static/file.png -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/_build/html/_static/minus.png -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/_build/html/_static/plus.png -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/_static/pygments.css: -------------------------------------------------------------------------------- 1 | pre { line-height: 125%; } 2 | td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 3 | span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 4 | td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 6 | .highlight .hll { background-color: #ffffcc } 7 | .highlight { background: #f8f8f8; } 8 | .highlight .c { color: #8f5902; font-style: italic } /* Comment */ 9 | .highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ 10 | .highlight .g { color: #000000 } /* Generic */ 11 | .highlight .k { color: #004461; font-weight: bold } /* Keyword */ 12 | .highlight .l { color: #000000 } /* Literal */ 13 | .highlight .n { color: #000000 } /* Name */ 14 | .highlight .o { color: #582800 } /* Operator */ 15 | .highlight .x { color: #000000 } /* Other */ 16 | .highlight .p { color: #000000; font-weight: bold } /* Punctuation */ 17 | .highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ 18 | .highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ 19 | .highlight .cp { color: #8f5902 } /* Comment.Preproc */ 20 | .highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ 21 | .highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ 22 | .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ 23 | .highlight .gd { color: #a40000 } /* Generic.Deleted */ 24 | .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ 25 | .highlight .gr { color: #ef2929 } /* Generic.Error */ 26 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 27 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 28 | .highlight .go { color: #888888 } /* Generic.Output */ 29 | .highlight .gp { color: #745334 } /* Generic.Prompt */ 30 | .highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ 31 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 32 | .highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ 33 | .highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ 34 | .highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ 35 | .highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ 36 | .highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ 37 | .highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ 38 | .highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ 39 | .highlight .ld { color: #000000 } /* Literal.Date */ 40 | .highlight .m { color: #990000 } /* Literal.Number */ 41 | .highlight .s { color: #4e9a06 } /* Literal.String */ 42 | .highlight .na { color: #c4a000 } /* Name.Attribute */ 43 | .highlight .nb { color: #004461 } /* Name.Builtin */ 44 | .highlight .nc { color: #000000 } /* Name.Class */ 45 | .highlight .no { color: #000000 } /* Name.Constant */ 46 | .highlight .nd { color: #888888 } /* Name.Decorator */ 47 | .highlight .ni { color: #ce5c00 } /* Name.Entity */ 48 | .highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ 49 | .highlight .nf { color: #000000 } /* Name.Function */ 50 | .highlight .nl { color: #f57900 } /* Name.Label */ 51 | .highlight .nn { color: #000000 } /* Name.Namespace */ 52 | .highlight .nx { color: #000000 } /* Name.Other */ 53 | .highlight .py { color: #000000 } /* Name.Property */ 54 | .highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ 55 | .highlight .nv { color: #000000 } /* Name.Variable */ 56 | .highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ 57 | .highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ 58 | .highlight .mb { color: #990000 } /* Literal.Number.Bin */ 59 | .highlight .mf { color: #990000 } /* Literal.Number.Float */ 60 | .highlight .mh { color: #990000 } /* Literal.Number.Hex */ 61 | .highlight .mi { color: #990000 } /* Literal.Number.Integer */ 62 | .highlight .mo { color: #990000 } /* Literal.Number.Oct */ 63 | .highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ 64 | .highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ 65 | .highlight .sc { color: #4e9a06 } /* Literal.String.Char */ 66 | .highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ 67 | .highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ 68 | .highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ 69 | .highlight .se { color: #4e9a06 } /* Literal.String.Escape */ 70 | .highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ 71 | .highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ 72 | .highlight .sx { color: #4e9a06 } /* Literal.String.Other */ 73 | .highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ 74 | .highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ 75 | .highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ 76 | .highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ 77 | .highlight .fm { color: #000000 } /* Name.Function.Magic */ 78 | .highlight .vc { color: #000000 } /* Name.Variable.Class */ 79 | .highlight .vg { color: #000000 } /* Name.Variable.Global */ 80 | .highlight .vi { color: #000000 } /* Name.Variable.Instance */ 81 | .highlight .vm { color: #000000 } /* Name.Variable.Magic */ 82 | .highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/genindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Index — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 |
28 |
29 | 30 | 31 |
32 | 33 | 34 |

Index

35 | 36 |
37 | H 38 | | M 39 | 40 |
41 |

H

42 | 43 | 47 |
48 | 49 |

M

50 | 51 | 55 |
56 | 57 | 58 | 59 |
60 | 61 |
62 |
63 | 109 |
110 |
111 |
112 | ©2021, Paul Everitt . 113 | 114 | | 115 | Powered by Sphinx 4.3.2 116 | & Alabaster 0.7.12 117 | 118 |
119 | 120 | 121 | 122 | 123 | 124 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | Schlockchain Homepage — Schlockchain documentation 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |
36 |

Schlockchain Homepage

37 |

Welcome to the future.

38 |

The logo is at the Python logo.

39 |

More information about Schlockchain is available in About Us.

40 |

You can also visit our Investors.

41 |
42 |

Contents: 43 |

44 | 48 |
49 |
50 | 51 | 52 |
53 | 54 |
55 |
56 | 103 |
104 |
105 |
106 | ©2021, Paul Everitt . 107 | 108 | | 109 | Powered by Sphinx 4.3.2 110 | & Alabaster 0.7.12 111 | 112 | | 113 | Page source 115 |
116 | 117 | 118 | 119 | 120 | 121 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/_build/html/objects.inv -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/search.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Search — Schlockchain documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 |
33 |
34 |
35 | 36 | 37 |
38 | 39 |

Search

40 | 41 | 49 | 50 | 51 |

52 | Searching for multiple words only shows matches that contain 53 | all words. 54 |

55 | 56 | 57 |
58 | 59 | 60 | 61 |
62 | 63 | 64 | 65 |
66 | 67 |
68 | 69 | 70 |
71 | 72 |
73 |
74 | 110 |
111 |
112 |
113 | ©2021, Paul Everitt . 114 | 115 | | 116 | Powered by Sphinx 4.3.2 117 | & Alabaster 0.7.12 118 | 119 |
120 | 121 | 122 | 123 | 124 | 125 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/_build/html/searchindex.js: -------------------------------------------------------------------------------- 1 | Search.setIndex({docnames:["about_us","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["about_us.md","index.md"],objects:{"my_demo.MyDemo":[[0,1,1,"","hello"]],my_demo:[[0,0,1,"","MyDemo"]]},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"class":0,"function":0,"return":0,A:0,As:0,For:0,The:[0,1],__init__:0,about:1,advic:0,algorithm:0,also:1,an:0,ar:0,arbitrari:0,arg:0,avail:1,awesom:0,b:0,best:0,bold:0,can:[0,1],canon:0,care:0,carousel:0,come:0,continu:0,counsel:0,cross:0,data:0,def:0,demo:0,descript:0,download:0,ever:0,exampl:0,f:0,foundat:0,from:0,fun:0,futur:1,get:0,glacial:0,glacier:0,glad:0,great:0,greet:0,have:0,hello:0,homepag:0,hw:0,i:0,inform:1,innov:0,invest:0,investor:1,involv:0,leader:0,let:0,life:0,llc:0,locat:0,logo:[0,1],longer:0,look:0,m:0,make:0,mega_chain:0,melt:0,more:1,msg:0,my:0,my_demo:0,mydemo:1,name:0,nobodi:0,offlin:0,our:[0,1],paramet:0,patent:0,person:0,photo:0,power:0,proud:0,put:0,python:[0,1],realli:0,reason:0,referenc:0,roadmap:0,round:0,rst:0,s:0,sai:0,said:0,save:0,schlockchain:0,scienc:0,see:0,self:0,seri:0,sexi:0,slow:0,so:0,softwar:0,some:0,someth:0,start:0,stock:0,str:0,success:0,take:0,talk:0,thi:0,thing:0,thought:0,thu:0,type:0,upon:0,us:1,veri:0,visit:[0,1],warn:0,we:0,welcom:1,well:0,which:0,work:0,world:0,written:0,you:[0,1]},titles:["About Us","Schlockchain Homepage"],titleterms:{about:0,content:1,homepag:1,investor:0,mydemo:0,redact:0,schlockchain:1,us:0}}) -------------------------------------------------------------------------------- /code/07-linking-between-sites/about_us.md: -------------------------------------------------------------------------------- 1 | # About Us 2 | 3 | We are Schlockchain, thought leaders in innovation. 4 | 5 | We are **bold** and *innovative*. 6 | 7 | Our `def mega_chain` function works really well: 8 | 9 | def mega_chain(): return 10 | 11 | Investors say the best things about us: 12 | 13 | > I'm so glad I put my life savings in Schlockchain. 14 | > > Said Nobody Ever 15 | 16 | We have a patented algorithm: 17 | - Glacially slow 18 | - Which melts glaciers 19 | 20 | ...and a roadmap to success: 21 | 22 | 1. Start an LLC 23 | 2. Get a Series A investment round 24 | 3. Get a Series B investment round 25 | 4. Continue 26 | 27 | Schlockchain is written in [Python](https://www.python.org/) for some 28 | data science or something reasons. 29 | 30 | For a sexy carousel of stock photos, visit [](./index). 31 | 32 | ## Investors 33 | 34 | Our investors are very proud to be involved with us. 35 | 36 | ## Redacted 37 | 38 | Upon advice of counsel. 39 | 40 | ## Redacted 41 | 42 | Upon advice of counsel. 43 | 44 | ```{image} python-logo.png 45 | :alt: Python Logo 46 | :class: bg-primary 47 | :width: 200px 48 | :align: center 49 | ``` 50 | 51 | :::{figure-md} logo-target 52 | :class: myclass 53 | 54 | Python Logo 55 | 56 | Python comes from the *Python Software Foundation*. 57 | ::: 58 | 59 | ```{note} 60 | Schlockchain is written in [Python](https://www.python.org/) for 61 | some data science or something reasons. 62 | ``` 63 | 64 | ```{warning} 65 | Schlockchain is written in [Python](https://www.python.org/) for 66 | some data science or something reasons. 67 | 68 | - Careful, Python is *awesome* 69 | - Using it will thus make you *awesome* 70 | ``` 71 | 72 | :::{warning} Awesomeness Warning 73 | 74 | Schlockchain is written in [Python](https://www.python.org/) for 75 | some data science or something reasons. 76 | 77 | - Careful, Python is *awesome* 78 | - Using it will thus make you *awesome* 79 | ::: 80 | 81 | You can {download}`download the Python logo ` for offline use. 82 | 83 | (investors)= 84 | ## Investors 85 | 86 | Our investors are very proud to be involved with us. 87 | 88 | ``` 89 | def hello(name): 90 | return f'Hello {name}' 91 | ``` 92 | 93 | ```{code-block} javascript 94 | --- 95 | linenos: true 96 | emphasize-lines: 2 97 | --- 98 | function hello(msg) { 99 | return `Hello ${msg}` 100 | } 101 | ``` 102 | 103 | ```{literalinclude} my_demo.py 104 | --- 105 | emphasize-lines: 2-3 106 | --- 107 | ``` 108 | 109 | # About `MyDemo` 110 | 111 | Let's take a look at this Python class. 112 | 113 | ```{eval-rst} 114 | .. autoclass:: my_demo.MyDemo 115 | :members: 116 | ``` 117 | 118 | As we can see in {py:class}`HW `, Python is fun! 119 | 120 | Let's talk about the power of [](sphinx:ref-role). 121 | 122 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/conf.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | sys.path.insert(0, os.path.abspath(".")) 5 | 6 | project = "Schlockchain" 7 | copyright = "2021, Paul Everitt " 8 | author = "Paul Everitt " 9 | extensions = [ 10 | "myst_parser", 11 | "sphinx.ext.autodoc", 12 | "sphinx.ext.napoleon", 13 | "sphinx_autodoc_typehints", 14 | "sphinx.ext.intersphinx", 15 | ] 16 | exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"] 17 | html_static_path = ["_static"] 18 | templates_path = ["_templates"] 19 | myst_enable_extensions = [ 20 | "colon_fence", 21 | ] 22 | intersphinx_mapping = { 23 | "sphinx": ("https://www.sphinx-doc.org/en/master/", None), 24 | } 25 | myst_url_schemes = ["http", "https", ] 26 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/index.md: -------------------------------------------------------------------------------- 1 | # Schlockchain Homepage 2 | 3 | Welcome to the future. 4 | 5 | The logo is at {ref}`the Python logo `. 6 | 7 | More information about Schlockchain is available in [](about_us). 8 | 9 | You can also visit our {ref}`investors`. 10 | 11 | ```{toctree} 12 | --- 13 | maxdepth: 1 14 | caption: | 15 | Contents: 16 | glob: 17 | --- 18 | 19 | * 20 | ``` 21 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=. 11 | set BUILDDIR=_build 12 | 13 | if "%1" == "" goto help 14 | 15 | %SPHINXBUILD% >NUL 2>NUL 16 | if errorlevel 9009 ( 17 | echo. 18 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 19 | echo.installed, then set the SPHINXBUILD environment variable to point 20 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 21 | echo.may add the Sphinx directory to PATH. 22 | echo. 23 | echo.If you don't have Sphinx installed, grab it from 24 | echo.https://www.sphinx-doc.org/ 25 | exit /b 1 26 | ) 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/my_demo.py: -------------------------------------------------------------------------------- 1 | class MyDemo: 2 | """ A *great* demo """ 3 | 4 | def __init__(self, name): 5 | self.name = name 6 | 7 | def hello(self, greeting: str) -> str: 8 | """ The canonical hello world example. 9 | 10 | A *longer* description with some **RST**. 11 | 12 | Args: 13 | name: The person to say hello to. 14 | Returns: 15 | str: The greeting 16 | """ 17 | return f"{greeting} {self.name}" 18 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/python-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/code/07-linking-between-sites/python-logo.png -------------------------------------------------------------------------------- /code/07-linking-between-sites/requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx 2 | livereload 3 | myst-parser 4 | sphinx-autodoc-typehints 5 | -------------------------------------------------------------------------------- /code/07-linking-between-sites/run_livereload.py: -------------------------------------------------------------------------------- 1 | from livereload import Server, shell 2 | 3 | if __name__ == '__main__': 4 | server = Server() 5 | server.watch('*.rst', shell('make html'), delay=1) 6 | server.watch('*.md', shell('make html'), delay=1) 7 | server.watch('*.py', shell('make html'), delay=1) 8 | server.watch('_static/*', shell('make html'), delay=1) 9 | server.watch('_templates/*', shell('make html'), delay=1) 10 | server.serve(root='_build/html') 11 | -------------------------------------------------------------------------------- /readme_resources/sphinx-course.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/talkpython/static-sites-with-sphinx-and-markdown-course/90ec376505c497bf96d600d32047c5d96afd2eda/readme_resources/sphinx-course.png --------------------------------------------------------------------------------