Skip to content

Commit

Permalink
docs(ver): update after version increment
Browse files Browse the repository at this point in the history
  • Loading branch information
hahnec committed Apr 9, 2022
1 parent b5d739f commit 350a3d5
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 30 deletions.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 3e4f636db634e8252a60c03537049c6a
config: 321392cf4ae9314f31e79f463d20feb6
tags: 645f666f9bcd5a90fca523b33c5a78b7
3 changes: 2 additions & 1 deletion docs/build/html/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -731,8 +731,9 @@ dl.glossary dt {

.classifier:before {
font-style: normal;
margin: 0.5em;
margin: 0 0.5em;
content: ":";
display: inline-block;
}

abbr, acronym {
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.8.1',
VERSION: '0.9.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
13 changes: 10 additions & 3 deletions docs/build/html/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,10 @@ var Search = {
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
if (data !== '' && data !== undefined) {
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
var summary = Search.makeSearchSummary(data, searchterms, hlterms);
if (summary) {
listItem.append(summary);
}
}
Search.output.append(listItem);
setTimeout(function() {
Expand Down Expand Up @@ -325,7 +328,9 @@ var Search = {
var results = [];

for (var prefix in objects) {
for (var name in objects[prefix]) {
for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
var match = objects[prefix][iMatch];
var name = match[4];
var fullname = (prefix ? prefix + '.' : '') + name;
var fullnameLower = fullname.toLowerCase()
if (fullnameLower.indexOf(object) > -1) {
Expand All @@ -339,7 +344,6 @@ var Search = {
} else if (parts[parts.length - 1].indexOf(object) > -1) {
score += Scorer.objPartialMatch;
}
var match = objects[prefix][name];
var objname = objnames[match[1]][2];
var title = titles[match[0]];
// If more than one term searched for, we require other words to be
Expand Down Expand Up @@ -498,6 +502,9 @@ var Search = {
*/
makeSearchSummary : function(htmlText, keywords, hlwords) {
var text = Search.htmlToText(htmlText);
if (text == "") {
return null;
}
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
Expand Down
8 changes: 4 additions & 4 deletions docs/build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; PlenoptiCam 0.8.1 documentation</title>
<title>Index &#8212; PlenoptiCam 0.9.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Expand All @@ -21,7 +21,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
Expand Down Expand Up @@ -65,13 +65,13 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, Christopher Hahne.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>
8 changes: 4 additions & 4 deletions docs/build/html/guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>2. User Guide &#8212; PlenoptiCam 0.8.1 documentation</title>
<title>2. User Guide &#8212; PlenoptiCam 0.9.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Expand All @@ -25,7 +25,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="readme.html" title="1. PlenoptiCam"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">2. </span>User Guide</a></li>
</ul>
</div>
Expand Down Expand Up @@ -170,13 +170,13 @@ <h3>Navigation</h3>
<li class="right" >
<a href="readme.html" title="1. PlenoptiCam"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">2. </span>User Guide</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, Christopher Hahne.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>
8 changes: 4 additions & 4 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>PlenoptiCam’s Reference Document &#8212; PlenoptiCam 0.8.1 documentation</title>
<title>PlenoptiCam’s Reference Document &#8212; PlenoptiCam 0.9.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Expand All @@ -25,7 +25,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="readme.html" title="1. PlenoptiCam"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="#">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">PlenoptiCam’s Reference Document</a></li>
</ul>
</div>
Expand Down Expand Up @@ -97,13 +97,13 @@ <h3>Navigation</h3>
<li class="right" >
<a href="readme.html" title="1. PlenoptiCam"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="#">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">PlenoptiCam’s Reference Document</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, Christopher Hahne.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>
12 changes: 6 additions & 6 deletions docs/build/html/readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>1. PlenoptiCam &#8212; PlenoptiCam 0.8.1 documentation</title>
<title>1. PlenoptiCam &#8212; PlenoptiCam 0.9.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Expand All @@ -29,7 +29,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="index.html" title="PlenoptiCam’s Reference Document"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">1. </span>PlenoptiCam</a></li>
</ul>
</div>
Expand All @@ -43,7 +43,7 @@ <h3>Navigation</h3>
<h1><span class="section-number">1. </span>PlenoptiCam<a class="headerlink" href="#plenopticam" title="Permalink to this headline"></a></h1>
<div class="section" id="description">
<h2><span class="section-number">1.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p><em>PlenoptiCam</em> is an open-source software (<a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.8.1-beta/plenopticam_0.8.1.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.8.1-beta/plenopticam_0.8.1.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.8.1-beta/plenopticam_0.8.1.tar.gz">Linux</a>) for scientific light field computation with cross-platform compatibility, few dependencies and a lean graphical user interface.
<p><em>PlenoptiCam</em> is an open-source software (<a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.0-beta/plenopticam_0.9.0.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.0-beta/plenopticam_0.9.0.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.0-beta/plenopticam_0.9.0.tar.gz">Linux</a>) for scientific light field computation with cross-platform compatibility, few dependencies and a lean graphical user interface.
Raw exposures from a plenoptic camera require four-dimensional image alignment in order to be decoded as a light field. Provided software addresses this by its ability to calibrate an image taken by a plenoptic camera and extract sub-aperture images or synthetically focused photographs.
This application is meant for researchers, developers, beginners and other fiddlers who like to experiment with light field technology. Its scope comprises custom-types of plenoptic cameras and is thus not limited to Lytro’s image data.</p>
<p><a class="reference external" href="https://github.com/hahnec/plenopticam/releases/"><img alt="release" src="https://img.shields.io/github/release/hahnec/plenopticam.svg?style=flat-square" /></a> <a class="reference external" href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img alt="License" src="https://img.shields.io/badge/License-GPL%20v3.0-orange.svg?style=flat-square" /></a> <a class="reference external" href="https://travis-ci.com/github/hahnec/plenopticam"><img alt="travis" src="https://img.shields.io/travis/com/hahnec/plenopticam/master?style=flat-square" /></a> <a class="reference external" href="https://coveralls.io/github/hahnec/plenopticam"><img alt="coverage" src="https://img.shields.io/coveralls/github/hahnec/plenopticam?style=flat-square" /></a> <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/"><img alt="Release Downloads" src="https://img.shields.io/github/downloads/hahnec/plenopticam/total?label=Release%20downloads&amp;style=flat-square" /></a> <a class="reference external" href="https://pypi.org/project/plenopticam/"><img alt="PyPI Downloads" src="https://img.shields.io/pypi/dm/plenopticam?label=PyPI%20downloads&amp;style=flat-square" /></a></p>
Expand Down Expand Up @@ -127,7 +127,7 @@ <h2><span class="section-number">1.3. </span>Installation<a class="headerlink" h
<ul class="simple">
<li><dl class="simple">
<dt>executable:</dt><dd><ol class="arabic simple">
<li><p>download bundled <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/">apps</a> for <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.8.1-beta/plenopticam_0.8.1.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.8.1-beta/plenopticam_0.8.1.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.8.1-beta/plenopticam_0.8.1.tar.gz">Linux</a></p></li>
<li><p>download bundled <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/">apps</a> for <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.0-beta/plenopticam_0.9.0.dmg">macOS</a>, <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.0-beta/plenopticam_0.9.0.msi">Win</a> or <a class="reference external" href="https://github.com/hahnec/plenopticam/releases/download/v0.9.0-beta/plenopticam_0.9.0.tar.gz">Linux</a></p></li>
<li><p>run installer / extract archive</p></li>
<li><p>work around <a class="reference external" href="https://stackoverflow.com/a/65488937/10874787"><strong>Windows protection</strong></a> or <a class="reference external" href="https://osxdaily.com/2015/05/04/disable-gatekeeper-command-line-mac-osx/"><strong>macOS unidentified developer</strong></a> issue</p></li>
<li><p>run executable (may take a while on first start-up)</p></li>
Expand Down Expand Up @@ -375,13 +375,13 @@ <h3>Navigation</h3>
<li class="right" >
<a href="index.html" title="PlenoptiCam’s Reference Document"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">1. </span>PlenoptiCam</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, Christopher Hahne.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>
13 changes: 7 additions & 6 deletions docs/build/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &#8212; PlenoptiCam 0.8.1 documentation</title>
<title>Search &#8212; PlenoptiCam 0.9.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css" />

Expand All @@ -27,7 +27,7 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Search</a></li>
</ul>
</div>
Expand All @@ -39,13 +39,14 @@ <h3>Navigation</h3>

<h1 id="search-documentation">Search</h1>

<div id="fallback" class="admonition warning">
<script>$('#fallback').hide();</script>
<noscript>
<div class="admonition warning">
<p>
Please activate JavaScript to enable the search
functionality.
</p>
</div>
</noscript>


<p>
Expand Down Expand Up @@ -83,13 +84,13 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.8.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">PlenoptiCam 0.9.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Search</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, Christopher Hahne.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>

0 comments on commit 350a3d5

Please sign in to comment.