Commit 4a25f0a0ee90f4e387af58d05007e0a76562b743
1 parent
883ba9a0
More updates to MD switching back to RTD for distribution
Showing
7 changed files
with
48 additions
and
35 deletions
docs/docs/api_docs/python_api.md
| @@ -3,16 +3,22 @@ | @@ -3,16 +3,22 @@ | ||
| 3 | The Python API is a light wrapper of the C API. It creates an object that has [all the C functions](c_api/functions.md): | 3 | The Python API is a light wrapper of the C API. It creates an object that has [all the C functions](c_api/functions.md): |
| 4 | 4 | ||
| 5 | from brpy import init_brpy | 5 | from brpy import init_brpy |
| 6 | + | ||
| 6 | # br_loc is /usr/local/lib by default, | 7 | # br_loc is /usr/local/lib by default, |
| 7 | # you may change this by passing a different path to the shared objects | 8 | # you may change this by passing a different path to the shared objects |
| 8 | br = init_brpy(br_loc='/path/to/libopenbr') | 9 | br = init_brpy(br_loc='/path/to/libopenbr') |
| 9 | br.br_initialize_default() | 10 | br.br_initialize_default() |
| 11 | + | ||
| 10 | img = open('catpic.jpg','rb').read() | 12 | img = open('catpic.jpg','rb').read() |
| 13 | + | ||
| 11 | br.br_set_property('algorithm','MyCatFaceDetectionModel') | 14 | br.br_set_property('algorithm','MyCatFaceDetectionModel') |
| 12 | br.br_set_property('enrollAll','true') | 15 | br.br_set_property('enrollAll','true') |
| 16 | + | ||
| 13 | tmpl = br.br_load_img(img, len(img)) | 17 | tmpl = br.br_load_img(img, len(img)) |
| 14 | catfaces = br.br_enroll_template(tmpl) | 18 | catfaces = br.br_enroll_template(tmpl) |
| 19 | + | ||
| 15 | print('This pic has %i cats in it!' % br.br_num_templates(catfaces)) | 20 | print('This pic has %i cats in it!' % br.br_num_templates(catfaces)) |
| 21 | + | ||
| 16 | br.br_free_template(tmpl) | 22 | br.br_free_template(tmpl) |
| 17 | br.br_free_template_list(catfaces) | 23 | br.br_free_template_list(catfaces) |
| 18 | br.br_finalize() | 24 | br.br_finalize() |
docs/docs/index.md
| @@ -13,7 +13,7 @@ Please read [our paper](http://openbiometrics.org/publications/klontz2013open.pd | @@ -13,7 +13,7 @@ Please read [our paper](http://openbiometrics.org/publications/klontz2013open.pd | ||
| 13 | 13 | ||
| 14 | --- | 14 | --- |
| 15 | 15 | ||
| 16 | -<figure id="abstraction"> | 16 | +<figure id="abstraction" style="display:block; margin: 0 auto;"> |
| 17 | <img src="img/abstraction.svg"> | 17 | <img src="img/abstraction.svg"> |
| 18 | <figcaption>The two principal software artifacts are the shared library 'openbr' and command line application 'br'.</figcaption> | 18 | <figcaption>The two principal software artifacts are the shared library 'openbr' and command line application 'br'.</figcaption> |
| 19 | </figure> | 19 | </figure> |
docs/themes/materialize/base.html
| @@ -50,20 +50,22 @@ | @@ -50,20 +50,22 @@ | ||
| 50 | </nav> | 50 | </nav> |
| 51 | </div> | 51 | </div> |
| 52 | 52 | ||
| 53 | - <ul id="slide-out" class="side-nav fixed"> | ||
| 54 | - <li class="logo" style="height: 120px;"> | ||
| 55 | - <a id="logo-container" href="http://openbiometrics.org/" class="brand-logo" style="width: 285px; height: 120px; padding-left: 85px; padding-top: 10px;"> | ||
| 56 | - <img src="{{ base_url }}/img/openbr.png" style="width: 100px; height: 100px;"> | ||
| 57 | - </a> | ||
| 58 | - </li> | ||
| 59 | - <hr style="margin: 0px;"> | 53 | + <div class="container"> |
| 54 | + <ul id="slide-out" class="side-nav fixed"> | ||
| 55 | + <li class="logo" style="height: 120px;"> | ||
| 56 | + <a id="logo-container" href="http://openbiometrics.org/" class="brand-logo" style="width: 285px; height: 120px; padding-left: 85px; padding-top: 10px;"> | ||
| 57 | + <img src="{{ base_url }}/img/openbr.png" style="width: 100px; height: 100px;"> | ||
| 58 | + </a> | ||
| 59 | + </li> | ||
| 60 | + <hr style="margin: 0px;"> | ||
| 60 | 61 | ||
| 61 | - {% for nav_item in nav %} | ||
| 62 | - {% include "nav.html" %} | ||
| 63 | - {% endfor %} | ||
| 64 | - </ul> | 62 | + {% for nav_item in nav %} |
| 63 | + {% include "nav.html" %} | ||
| 64 | + {% endfor %} | ||
| 65 | + </ul> | ||
| 66 | + </div> | ||
| 65 | </header> | 67 | </header> |
| 66 | - | 68 | + |
| 67 | <main> | 69 | <main> |
| 68 | <div class="container"> | 70 | <div class="container"> |
| 69 | <div class="row"> | 71 | <div class="row"> |
| @@ -73,15 +75,9 @@ | @@ -73,15 +75,9 @@ | ||
| 73 | </div> | 75 | </div> |
| 74 | 76 | ||
| 75 | <div class="col m3 l2"> | 77 | <div class="col m3 l2"> |
| 76 | - <div class="toc-wrapper" style="position: fixed;"> | ||
| 77 | - <span class="card-title">Table of Contents</span> | ||
| 78 | - <div class="divider"></div> | ||
| 79 | - <ul class="section table-of-contents"> | ||
| 80 | - {% for toc_item in toc %} | ||
| 81 | - <li class="no-padding"><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li> | ||
| 82 | - {% endfor %} | ||
| 83 | - </ul> | ||
| 84 | - </div> | 78 | + {% if toc.items %} |
| 79 | + {% include "toc.html" %} | ||
| 80 | + {% endif %} | ||
| 85 | </div> | 81 | </div> |
| 86 | {% endblock %} | 82 | {% endblock %} |
| 87 | </div> | 83 | </div> |
docs/themes/materialize/css/materialize.css
| @@ -2036,7 +2036,7 @@ ul { | @@ -2036,7 +2036,7 @@ ul { | ||
| 2036 | blockquote { | 2036 | blockquote { |
| 2037 | margin: 20px 0; | 2037 | margin: 20px 0; |
| 2038 | padding-left: 1.5rem; | 2038 | padding-left: 1.5rem; |
| 2039 | - border-left: 5px solid #EF9A9A; } | 2039 | + border-left: 5px solid #37474f; } |
| 2040 | 2040 | ||
| 2041 | i { | 2041 | i { |
| 2042 | line-height: inherit; } | 2042 | line-height: inherit; } |
| @@ -5926,15 +5926,15 @@ a.waves-effect .waves-ripple { | @@ -5926,15 +5926,15 @@ a.waves-effect .waves-ripple { | ||
| 5926 | .side-nav .collapsible-header { | 5926 | .side-nav .collapsible-header { |
| 5927 | background-color: transparent; | 5927 | background-color: transparent; |
| 5928 | border: none; | 5928 | border: none; |
| 5929 | - line-height: inherit; | ||
| 5930 | - height: inherit; | 5929 | + /*line-height: inherit; |
| 5930 | + height: inherit;*/ | ||
| 5931 | margin: 0 1rem; } | 5931 | margin: 0 1rem; } |
| 5932 | .side-nav .collapsible-header i { | 5932 | .side-nav .collapsible-header i { |
| 5933 | line-height: inherit; } | 5933 | line-height: inherit; } |
| 5934 | .side-nav .collapsible-body { | 5934 | .side-nav .collapsible-body { |
| 5935 | border: 0; | 5935 | border: 0; |
| 5936 | background-color: #FFF; } | 5936 | background-color: #FFF; } |
| 5937 | - .side-nav .collapsible-body li a { | 5937 | + .side-nav .collapsible-body li a { |
| 5938 | margin: 0 1rem 0 2rem; } | 5938 | margin: 0 1rem 0 2rem; } |
| 5939 | 5939 | ||
| 5940 | .collapsible.popout { | 5940 | .collapsible.popout { |
docs/themes/materialize/js/theme.js
| 1 | +$(document).ready(function(){ | ||
| 2 | + $('.toc-wrapper').pushpin({ top: $('nav').height() }); | ||
| 3 | + | ||
| 4 | + $('.scrollspy').scrollSpy(); | ||
| 5 | + $('.button-collapse').sideNav({'edge': 'left'}); | ||
| 6 | +}) | ||
| 7 | + | ||
| 1 | $('.button-collapse').sideNav({ | 8 | $('.button-collapse').sideNav({ |
| 2 | menuWidth: 300, // Default is 240 | 9 | menuWidth: 300, // Default is 240 |
| 3 | edge: 'right', // Choose the horizontal origin | 10 | edge: 'right', // Choose the horizontal origin |
| 4 | closeOnClick: true // Closes side-nav on <a> clicks, useful for Angular/Meteor | 11 | closeOnClick: true // Closes side-nav on <a> clicks, useful for Angular/Meteor |
| 5 | } | 12 | } |
| 6 | ); | 13 | ); |
| 14 | +$('.collapsible').collapsible(); |
docs/themes/materialize/nav.html
| 1 | {% if nav_item.children %} | 1 | {% if nav_item.children %} |
| 2 | <li class="no-padding {% if nav_item.active %}active{% endif %}"> | 2 | <li class="no-padding {% if nav_item.active %}active{% endif %}"> |
| 3 | - <ul class="collapsible collapsible-accordion"> | ||
| 4 | - <li class="{% if nav_item.active %}active{% endif %}"> | 3 | + <ul class="collapsible {% if nav_item.active %}active{% endif %}"> |
| 4 | + <li class="bold {% if nav_item.active %}active{% endif %}"> | ||
| 5 | <a class="collapsible-header waves-effect waves-teal">{{ nav_item.title }}</a> | 5 | <a class="collapsible-header waves-effect waves-teal">{{ nav_item.title }}</a> |
| 6 | <div class="collapsible-body"> | 6 | <div class="collapsible-body"> |
| 7 | <ul> | 7 | <ul> |
| @@ -15,6 +15,6 @@ | @@ -15,6 +15,6 @@ | ||
| 15 | </li> | 15 | </li> |
| 16 | {% else %} | 16 | {% else %} |
| 17 | <li class="{% if nav_item.active %}active{% endif %}"> | 17 | <li class="{% if nav_item.active %}active{% endif %}"> |
| 18 | - <a href="{{ nav_item.url }}">{{ nav_item.title }}</a> | 18 | + <a class="waves-effect waves-teal" href="{{ nav_item.url }}">{{ nav_item.title }}</a> |
| 19 | </li> | 19 | </li> |
| 20 | {% endif %} | 20 | {% endif %} |
docs/themes/materialize/toc.html
| 1 | -<ul> | ||
| 2 | - <li><span>Table of Contents</span></li> | ||
| 3 | - {% for toc_item in toc %} | ||
| 4 | - <li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li> | ||
| 5 | - {% endfor %} | ||
| 6 | -</ul> | 1 | +<div class="toc-wrapper" style="position: fixed; overflow: scroll; height: 70%; width: 100%;"> |
| 2 | + <span class="card-title">Table of Contents</span> | ||
| 3 | + <div class="divider" style="width: 125px;"></div> | ||
| 4 | + <ul class="section table-of-contents"> | ||
| 5 | + {% for toc_item in toc %} | ||
| 6 | + <li class="no-padding"><a href="{{ toc_item.url }}"><span>{{ toc_item.title }}</span></a></li> | ||
| 7 | + {% endfor %} | ||
| 8 | + </ul> | ||
| 9 | +</div> |