diff options
author | Blake DeMarcy <ofunknowndescent@gmail.com> | 2017-05-03 21:42:59 -0500 |
---|---|---|
committer | Blake DeMarcy <ofunknowndescent@gmail.com> | 2017-05-03 21:42:59 -0500 |
commit | 416881ad6f0e8136de05fb4cdad930d3fa595b31 (patch) | |
tree | b7e78a7059d7cc91f46587ffa885e9381d6755a8 | |
parent | dc1694e0f400fe2a0eb2116f409569fb27e8e7a7 (diff) | |
download | bbj-416881ad6f0e8136de05fb4cdad930d3fa595b31.tar.gz |
i hate my life
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | docs/docs/api_overview.md (renamed from documentation/docs/api_overview.md) | 0 | ||||
-rw-r--r-- | docs/docs/errors.md (renamed from documentation/docs/errors.md) | 0 | ||||
-rw-r--r-- | docs/docs/img/screenshot.png (renamed from documentation/docs/img/screenshot.png) | bin | 229126 -> 229126 bytes | |||
-rw-r--r-- | docs/docs/index.md (renamed from documentation/docs/index.md) | 0 | ||||
-rw-r--r-- | docs/docs/validation.md (renamed from documentation/docs/validation.md) | 0 | ||||
-rw-r--r-- | docs/mkdocs.yml (renamed from documentation/mkdocs.yml) | 0 | ||||
-rw-r--r-- | docs/site/404.html | 125 | ||||
-rw-r--r-- | docs/site/api_overview/index.html (renamed from documentation/site/api_overview/index.html) | 0 | ||||
-rw-r--r-- | docs/site/css/base.css (renamed from documentation/site/css/base.css) | 0 | ||||
-rw-r--r-- | docs/site/css/bootstrap-custom.min.css (renamed from documentation/site/css/bootstrap-custom.min.css) | 0 | ||||
-rw-r--r-- | docs/site/css/font-awesome-4.5.0.css (renamed from documentation/site/css/font-awesome-4.5.0.css) | 0 | ||||
-rw-r--r-- | docs/site/css/highlight.css (renamed from documentation/site/css/highlight.css) | 0 | ||||
-rw-r--r-- | docs/site/errors/index.html (renamed from documentation/site/errors/index.html) | 0 | ||||
-rw-r--r-- | docs/site/fonts/fontawesome-webfont.eot (renamed from documentation/site/fonts/fontawesome-webfont.eot) | bin | 70807 -> 70807 bytes | |||
-rw-r--r-- | docs/site/fonts/fontawesome-webfont.svg (renamed from documentation/site/fonts/fontawesome-webfont.svg) | 0 | ||||
-rw-r--r-- | docs/site/fonts/fontawesome-webfont.ttf (renamed from documentation/site/fonts/fontawesome-webfont.ttf) | bin | 142072 -> 142072 bytes | |||
-rw-r--r-- | docs/site/fonts/fontawesome-webfont.woff (renamed from documentation/site/fonts/fontawesome-webfont.woff) | bin | 83588 -> 83588 bytes | |||
-rw-r--r-- | docs/site/fonts/fontawesome-webfont.woff2 (renamed from documentation/site/fonts/fontawesome-webfont.woff2) | bin | 66624 -> 66624 bytes | |||
-rw-r--r-- | docs/site/fonts/glyphicons-halflings-regular.eot (renamed from documentation/site/fonts/glyphicons-halflings-regular.eot) | bin | 20127 -> 20127 bytes | |||
-rw-r--r-- | docs/site/fonts/glyphicons-halflings-regular.svg (renamed from documentation/site/fonts/glyphicons-halflings-regular.svg) | 0 | ||||
-rw-r--r-- | docs/site/fonts/glyphicons-halflings-regular.ttf (renamed from documentation/site/fonts/glyphicons-halflings-regular.ttf) | bin | 45404 -> 45404 bytes | |||
-rw-r--r-- | docs/site/fonts/glyphicons-halflings-regular.woff (renamed from documentation/site/fonts/glyphicons-halflings-regular.woff) | bin | 23424 -> 23424 bytes | |||
-rw-r--r-- | docs/site/fonts/glyphicons-halflings-regular.woff2 (renamed from documentation/site/fonts/glyphicons-halflings-regular.woff2) | bin | 18028 -> 18028 bytes | |||
-rw-r--r-- | docs/site/img/favicon.ico (renamed from documentation/site/img/favicon.ico) | bin | 1150 -> 1150 bytes | |||
-rw-r--r-- | docs/site/img/grid.png (renamed from documentation/site/img/grid.png) | bin | 1458 -> 1458 bytes | |||
-rw-r--r-- | docs/site/img/screenshot.png (renamed from documentation/site/img/screenshot.png) | bin | 229126 -> 229126 bytes | |||
-rw-r--r-- | docs/site/index.html | 153 | ||||
-rw-r--r-- | docs/site/js/base.js | 62 | ||||
-rw-r--r-- | docs/site/js/bootstrap-3.0.3.min.js (renamed from documentation/site/js/bootstrap-3.0.3.min.js) | 0 | ||||
-rw-r--r-- | docs/site/js/highlight.pack.js (renamed from documentation/site/js/highlight.pack.js) | 0 | ||||
-rw-r--r-- | docs/site/js/jquery-1.10.2.min.js (renamed from documentation/site/js/jquery-1.10.2.min.js) | 0 | ||||
-rw-r--r-- | docs/site/mkdocs/js/lunr.min.js (renamed from documentation/site/mkdocs/js/lunr.min.js) | 0 | ||||
-rw-r--r-- | docs/site/mkdocs/js/mustache.min.js (renamed from documentation/site/mkdocs/js/mustache.min.js) | 0 | ||||
-rw-r--r-- | docs/site/mkdocs/js/require.js (renamed from documentation/site/mkdocs/js/require.js) | 0 | ||||
-rw-r--r-- | docs/site/mkdocs/js/search-results-template.mustache (renamed from documentation/site/mkdocs/js/search-results-template.mustache) | 0 | ||||
-rw-r--r-- | docs/site/mkdocs/js/search.js (renamed from documentation/site/mkdocs/js/search.js) | 0 | ||||
-rw-r--r-- | docs/site/mkdocs/js/text.js (renamed from documentation/site/mkdocs/js/text.js) | 0 | ||||
-rw-r--r-- | docs/site/mkdocs/search_index.json (renamed from documentation/site/mkdocs/search_index.json) | 0 | ||||
-rw-r--r-- | docs/site/sitemap.xml (renamed from documentation/site/sitemap.xml) | 0 | ||||
-rw-r--r-- | docs/site/validation/index.html (renamed from documentation/site/validation/index.html) | 0 | ||||
-rwxr-xr-x | gendocs.sh | 2 | ||||
-rw-r--r-- | mkendpoints.py | 4 |
43 files changed, 343 insertions, 4 deletions
@@ -1,3 +1,2 @@ /*.db /config.json -/documentation/site/js/base.js diff --git a/documentation/docs/api_overview.md b/docs/docs/api_overview.md index eec562d..eec562d 100644 --- a/documentation/docs/api_overview.md +++ b/docs/docs/api_overview.md diff --git a/documentation/docs/errors.md b/docs/docs/errors.md index 4144fbd..4144fbd 100644 --- a/documentation/docs/errors.md +++ b/docs/docs/errors.md diff --git a/documentation/docs/img/screenshot.png b/docs/docs/img/screenshot.png Binary files differindex dd61722..dd61722 100644 --- a/documentation/docs/img/screenshot.png +++ b/docs/docs/img/screenshot.png diff --git a/documentation/docs/index.md b/docs/docs/index.md index 52415ee..52415ee 100644 --- a/documentation/docs/index.md +++ b/docs/docs/index.md diff --git a/documentation/docs/validation.md b/docs/docs/validation.md index b039941..b039941 100644 --- a/documentation/docs/validation.md +++ b/docs/docs/validation.md diff --git a/documentation/mkdocs.yml b/docs/mkdocs.yml index 5337895..5337895 100644 --- a/documentation/mkdocs.yml +++ b/docs/mkdocs.yml diff --git a/docs/site/404.html b/docs/site/404.html new file mode 100644 index 0000000..1041bdf --- /dev/null +++ b/docs/site/404.html @@ -0,0 +1,125 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + + + <link rel="shortcut icon" href="/img/favicon.ico"> + <title>BBJ</title> + <link href="/css/bootstrap-custom.min.css" rel="stylesheet"> + <link href="/css/font-awesome-4.5.0.css" rel="stylesheet"> + <link href="/css/base.css" rel="stylesheet"> + <link rel="stylesheet" href="/css/highlight.css"> + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script> + <![endif]--> + + <script src="/js/jquery-1.10.2.min.js"></script> + <script src="/js/bootstrap-3.0.3.min.js"></script> + <script src="/js/highlight.pack.js"></script> + </head> + + <body> + + <div class="navbar navbar-default navbar-fixed-top" role="navigation"> + <div class="container"> + + <!-- Collapsed navigation --> + <div class="navbar-header"> + <!-- Expander button --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="/">BBJ</a> + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav"> + <li > + <a href="/">Home</a> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">API <b class="caret"></b></a> + <ul class="dropdown-menu"> + +<li > + <a href="/api_overview/">Overview & Endpoints</a> +</li> + +<li > + <a href="/errors/">Errors</a> +</li> + +<li > + <a href="/validation/">Input Validation</a> +</li> + </ul> + </li> + </ul> + + <ul class="nav navbar-nav navbar-right"> + <li> + <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal"> + <i class="fa fa-search"></i> Search + </a> + </li> + </ul> + </div> + </div> +</div> + + <div class="container"> + + <div class="row-fluid"> + <div id="main-content" class="span12"> + <h1 id="404-page-not-found" style="text-align: center">404</h1> + <p style="text-align: center"><strong>Page not found</strong></p> + </div> + </div> + + + </div> + + <footer class="col-md-12"> + <hr> + <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p> + </footer> + <script>var base_url = '';</script> + <script data-main="/mkdocs/js/search.js" src="/mkdocs/js/require.js"></script> + <script src="/js/base.js"></script><div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true"> + <div class="modal-dialog"> + <div class="modal-content"> + <div class="modal-header"> + <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button> + <h4 class="modal-title" id="exampleModalLabel">Search</h4> + </div> + <div class="modal-body"> + <p> + From here you can search these documents. Enter + your search terms below. + </p> + <form role="form"> + <div class="form-group"> + <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query"> + </div> + </form> + <div id="mkdocs-search-results"></div> + </div> + <div class="modal-footer"> + </div> + </div> + </div> +</div> + + </body> +</html> diff --git a/documentation/site/api_overview/index.html b/docs/site/api_overview/index.html index 70168f7..70168f7 100644 --- a/documentation/site/api_overview/index.html +++ b/docs/site/api_overview/index.html diff --git a/documentation/site/css/base.css b/docs/site/css/base.css index 0d84f8a..0d84f8a 100644 --- a/documentation/site/css/base.css +++ b/docs/site/css/base.css diff --git a/documentation/site/css/bootstrap-custom.min.css b/docs/site/css/bootstrap-custom.min.css index d85b1dc..d85b1dc 100644 --- a/documentation/site/css/bootstrap-custom.min.css +++ b/docs/site/css/bootstrap-custom.min.css diff --git a/documentation/site/css/font-awesome-4.5.0.css b/docs/site/css/font-awesome-4.5.0.css index d0603cb..d0603cb 100644 --- a/documentation/site/css/font-awesome-4.5.0.css +++ b/docs/site/css/font-awesome-4.5.0.css diff --git a/documentation/site/css/highlight.css b/docs/site/css/highlight.css index 0ae40a7..0ae40a7 100644 --- a/documentation/site/css/highlight.css +++ b/docs/site/css/highlight.css diff --git a/documentation/site/errors/index.html b/docs/site/errors/index.html index edbb4b4..edbb4b4 100644 --- a/documentation/site/errors/index.html +++ b/docs/site/errors/index.html diff --git a/documentation/site/fonts/fontawesome-webfont.eot b/docs/site/fonts/fontawesome-webfont.eot Binary files differindex 9b6afae..9b6afae 100644 --- a/documentation/site/fonts/fontawesome-webfont.eot +++ b/docs/site/fonts/fontawesome-webfont.eot diff --git a/documentation/site/fonts/fontawesome-webfont.svg b/docs/site/fonts/fontawesome-webfont.svg index d05688e..d05688e 100644 --- a/documentation/site/fonts/fontawesome-webfont.svg +++ b/docs/site/fonts/fontawesome-webfont.svg diff --git a/documentation/site/fonts/fontawesome-webfont.ttf b/docs/site/fonts/fontawesome-webfont.ttf Binary files differindex 26dea79..26dea79 100644 --- a/documentation/site/fonts/fontawesome-webfont.ttf +++ b/docs/site/fonts/fontawesome-webfont.ttf diff --git a/documentation/site/fonts/fontawesome-webfont.woff b/docs/site/fonts/fontawesome-webfont.woff Binary files differindex dc35ce3..dc35ce3 100644 --- a/documentation/site/fonts/fontawesome-webfont.woff +++ b/docs/site/fonts/fontawesome-webfont.woff diff --git a/documentation/site/fonts/fontawesome-webfont.woff2 b/docs/site/fonts/fontawesome-webfont.woff2 Binary files differindex 500e517..500e517 100644 --- a/documentation/site/fonts/fontawesome-webfont.woff2 +++ b/docs/site/fonts/fontawesome-webfont.woff2 diff --git a/documentation/site/fonts/glyphicons-halflings-regular.eot b/docs/site/fonts/glyphicons-halflings-regular.eot Binary files differindex b93a495..b93a495 100644 --- a/documentation/site/fonts/glyphicons-halflings-regular.eot +++ b/docs/site/fonts/glyphicons-halflings-regular.eot diff --git a/documentation/site/fonts/glyphicons-halflings-regular.svg b/docs/site/fonts/glyphicons-halflings-regular.svg index 94fb549..94fb549 100644 --- a/documentation/site/fonts/glyphicons-halflings-regular.svg +++ b/docs/site/fonts/glyphicons-halflings-regular.svg diff --git a/documentation/site/fonts/glyphicons-halflings-regular.ttf b/docs/site/fonts/glyphicons-halflings-regular.ttf Binary files differindex 1413fc6..1413fc6 100644 --- a/documentation/site/fonts/glyphicons-halflings-regular.ttf +++ b/docs/site/fonts/glyphicons-halflings-regular.ttf diff --git a/documentation/site/fonts/glyphicons-halflings-regular.woff b/docs/site/fonts/glyphicons-halflings-regular.woff Binary files differindex 9e61285..9e61285 100644 --- a/documentation/site/fonts/glyphicons-halflings-regular.woff +++ b/docs/site/fonts/glyphicons-halflings-regular.woff diff --git a/documentation/site/fonts/glyphicons-halflings-regular.woff2 b/docs/site/fonts/glyphicons-halflings-regular.woff2 Binary files differindex 64539b5..64539b5 100644 --- a/documentation/site/fonts/glyphicons-halflings-regular.woff2 +++ b/docs/site/fonts/glyphicons-halflings-regular.woff2 diff --git a/documentation/site/img/favicon.ico b/docs/site/img/favicon.ico Binary files differindex e85006a..e85006a 100644 --- a/documentation/site/img/favicon.ico +++ b/docs/site/img/favicon.ico diff --git a/documentation/site/img/grid.png b/docs/site/img/grid.png Binary files differindex 878c3ed..878c3ed 100644 --- a/documentation/site/img/grid.png +++ b/docs/site/img/grid.png diff --git a/documentation/site/img/screenshot.png b/docs/site/img/screenshot.png Binary files differindex dd61722..dd61722 100644 --- a/documentation/site/img/screenshot.png +++ b/docs/site/img/screenshot.png diff --git a/docs/site/index.html b/docs/site/index.html new file mode 100644 index 0000000..89fa8a1 --- /dev/null +++ b/docs/site/index.html @@ -0,0 +1,153 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content="None"> + + + <link rel="shortcut icon" href="./img/favicon.ico"> + <title>BBJ</title> + <link href="./css/bootstrap-custom.min.css" rel="stylesheet"> + <link href="./css/font-awesome-4.5.0.css" rel="stylesheet"> + <link href="./css/base.css" rel="stylesheet"> + <link rel="stylesheet" href="./css/highlight.css"> + <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script> + <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script> + <![endif]--> + + <script src="./js/jquery-1.10.2.min.js"></script> + <script src="./js/bootstrap-3.0.3.min.js"></script> + <script src="./js/highlight.pack.js"></script> + </head> + + <body class="homepage"> + + <div class="navbar navbar-default navbar-fixed-top" role="navigation"> + <div class="container"> + + <!-- Collapsed navigation --> + <div class="navbar-header"> + <!-- Expander button --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href=".">BBJ</a> + </div> + + <!-- Expanded navigation --> + <div class="navbar-collapse collapse"> + <!-- Main navigation --> + <ul class="nav navbar-nav"> + <li class="active"> + <a href=".">Home</a> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">API <b class="caret"></b></a> + <ul class="dropdown-menu"> + +<li > + <a href="api_overview/">Overview & Endpoints</a> +</li> + +<li > + <a href="errors/">Errors</a> +</li> + +<li > + <a href="validation/">Input Validation</a> +</li> + </ul> + </li> + </ul> + + <ul class="nav navbar-nav navbar-right"> + <li> + <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal"> + <i class="fa fa-search"></i> Search + </a> + </li> + <li class="disabled"> + <a rel="next" > + <i class="fa fa-arrow-left"></i> Previous + </a> + </li> + <li > + <a rel="prev" href="api_overview/"> + Next <i class="fa fa-arrow-right"></i> + </a> + </li> + </ul> + </div> + </div> +</div> + + <div class="container"> + <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary"> + <ul class="nav bs-sidenav"> + <li class="main active"><a href="#bulletin-butter-jelly">Bulletin Butter & Jelly</a></li> + <li><a href="#a-simple-community-textboard">A simple community textboard</a></li> + </ul> +</div></div> + <div class="col-md-9" role="main"> + +<h1 id="bulletin-butter-jelly">Bulletin Butter & Jelly</h1> +<h2 id="a-simple-community-textboard">A simple community textboard</h2> +<h3 id="bbj-is-trivial-collection-of-python-scripts-and-database-queries-that-miraculously-shit-out-a-fully-functional-client-server-textboard">BBJ is trivial collection of python scripts and database queries that miraculously shit out a fully functional client-server textboard.</h3> +<p>See also: the <a href="https://github.com/desvox/bbj">GitHub repository</a>.</p> +<p>BBJ is heavily inspired by image boards like 4chan, but it offers a simple +account system to allow users to identify themselves and set profile +attributes like a more traditional forum. Registration is optional and there +are only minimal restrictions on anonymous participation.</p> +<p><img alt="screenshot" src="./img/screenshot.png" /></p> +<p>Being a command-line-oriented text board, BBJ has no avatars or file sharing +capabilties, so its easier to administrate and can't be used to distribute illegal +content like imageboards. It has very few dependancies and is easy to set up.</p> +<p>The API is simple and doesn't use require complex authorization schemes or session management. +It is fully documented on this site.</p></div> + </div> + + <footer class="col-md-12"> + <hr> + <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p> + </footer> + <script>var base_url = '.';</script> + <script data-main="./mkdocs/js/search.js" src="./mkdocs/js/require.js"></script> + <script src="./js/base.js"></script><div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true"> + <div class="modal-dialog"> + <div class="modal-content"> + <div class="modal-header"> + <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button> + <h4 class="modal-title" id="exampleModalLabel">Search</h4> + </div> + <div class="modal-body"> + <p> + From here you can search these documents. Enter + your search terms below. + </p> + <form role="form"> + <div class="form-group"> + <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query"> + </div> + </form> + <div id="mkdocs-search-results"></div> + </div> + <div class="modal-footer"> + </div> + </div> + </div> +</div> + + </body> +</html> + +<!-- +MkDocs version : 0.16.3 +Build Date UTC : 2017-05-04 02:42:48 +--> diff --git a/docs/site/js/base.js b/docs/site/js/base.js new file mode 100644 index 0000000..b8eeb03 --- /dev/null +++ b/docs/site/js/base.js @@ -0,0 +1,62 @@ +function getSearchTerm() +{ + var sPageURL = window.location.search.substring(1); + var sURLVariables = sPageURL.split('&'); + for (var i = 0; i < sURLVariables.length; i++) + { + var sParameterName = sURLVariables[i].split('='); + if (sParameterName[0] == 'q') + { + return sParameterName[1]; + } + } +} + +$(document).ready(function() { + + var search_term = getSearchTerm(), + $search_modal = $('#mkdocs_search_modal'); + + if(search_term){ + $search_modal.modal(); + } + + // make sure search input gets autofocus everytime modal opens. + $search_modal.on('shown.bs.modal', function () { + $search_modal.find('#mkdocs-search-query').focus(); + }); + + // Highlight.js + hljs.initHighlightingOnLoad(); + $('table').addClass('table table-striped table-hover'); + + // Improve the scrollspy behaviour when users click on a TOC item. + $(".bs-sidenav a").on("click", function() { + var clicked = this; + setTimeout(function() { + var active = $('.nav li.active a'); + active = active[active.length - 1]; + if (clicked !== active) { + $(active).parent().removeClass("active"); + $(clicked).parent().addClass("active"); + } + }, 50); + }); + +}); + + +$('body').scrollspy({ + target: '.bs-sidebar', +}); + +/* Toggle the `clicky` class on the body when clicking links to let us + retrigger CSS animations. See ../css/base.css for more details. */ +$('a').click(function(e) { + $('body').toggleClass('clicky'); +}); + +/* Prevent disabled links from causing a page reload */ +$("li.disabled a").click(function() { + event.preventDefault(); +}); diff --git a/documentation/site/js/bootstrap-3.0.3.min.js b/docs/site/js/bootstrap-3.0.3.min.js index 1a6258e..1a6258e 100644 --- a/documentation/site/js/bootstrap-3.0.3.min.js +++ b/docs/site/js/bootstrap-3.0.3.min.js diff --git a/documentation/site/js/highlight.pack.js b/docs/site/js/highlight.pack.js index a5818df..a5818df 100644 --- a/documentation/site/js/highlight.pack.js +++ b/docs/site/js/highlight.pack.js diff --git a/documentation/site/js/jquery-1.10.2.min.js b/docs/site/js/jquery-1.10.2.min.js index da41706..da41706 100644 --- a/documentation/site/js/jquery-1.10.2.min.js +++ b/docs/site/js/jquery-1.10.2.min.js diff --git a/documentation/site/mkdocs/js/lunr.min.js b/docs/site/mkdocs/js/lunr.min.js index b0198df..b0198df 100644 --- a/documentation/site/mkdocs/js/lunr.min.js +++ b/docs/site/mkdocs/js/lunr.min.js diff --git a/documentation/site/mkdocs/js/mustache.min.js b/docs/site/mkdocs/js/mustache.min.js index 7fc6da8..7fc6da8 100644 --- a/documentation/site/mkdocs/js/mustache.min.js +++ b/docs/site/mkdocs/js/mustache.min.js diff --git a/documentation/site/mkdocs/js/require.js b/docs/site/mkdocs/js/require.js index 8638a31..8638a31 100644 --- a/documentation/site/mkdocs/js/require.js +++ b/docs/site/mkdocs/js/require.js diff --git a/documentation/site/mkdocs/js/search-results-template.mustache b/docs/site/mkdocs/js/search-results-template.mustache index a8b3862..a8b3862 100644 --- a/documentation/site/mkdocs/js/search-results-template.mustache +++ b/docs/site/mkdocs/js/search-results-template.mustache diff --git a/documentation/site/mkdocs/js/search.js b/docs/site/mkdocs/js/search.js index d5c8661..d5c8661 100644 --- a/documentation/site/mkdocs/js/search.js +++ b/docs/site/mkdocs/js/search.js diff --git a/documentation/site/mkdocs/js/text.js b/docs/site/mkdocs/js/text.js index 17921b6..17921b6 100644 --- a/documentation/site/mkdocs/js/text.js +++ b/docs/site/mkdocs/js/text.js diff --git a/documentation/site/mkdocs/search_index.json b/docs/site/mkdocs/search_index.json index a977d96..a977d96 100644 --- a/documentation/site/mkdocs/search_index.json +++ b/docs/site/mkdocs/search_index.json diff --git a/documentation/site/sitemap.xml b/docs/site/sitemap.xml index fd79ccf..fd79ccf 100644 --- a/documentation/site/sitemap.xml +++ b/docs/site/sitemap.xml diff --git a/documentation/site/validation/index.html b/docs/site/validation/index.html index 897c330..897c330 100644 --- a/documentation/site/validation/index.html +++ b/docs/site/validation/index.html @@ -4,6 +4,6 @@ # Nothing magical here. python3 ./mkendpoints.py -cd ./documentation +cd ./docs mkdocs build cd .. diff --git a/mkendpoints.py b/mkendpoints.py index c1d4aea..09f3366 100644 --- a/mkendpoints.py +++ b/mkendpoints.py @@ -1,7 +1,7 @@ """ This is a small script that creates the endpoint doc page. It should be evoked from the command line each time changes are made. It writes -to ./documentation/docs/api_overview.md +to ./docs/docs/api_overview.md The code used in this script is the absolute minimum required to get the job done; it can be considered a crude hack at best. I am @@ -129,5 +129,5 @@ for doctype in sorted(types.keys()): body += "\n\n" + pydoc.getdoc(f) + "\n\n" body += "\n<br>\n" -with open("documentation/docs/api_overview.md", "w") as output: +with open("docs/docs/api_overview.md", "w") as output: output.write(body) |