Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul K. Korir, PhD committed Oct 4, 2017
1 parent 0dc1208 commit b720fcf
Show file tree
Hide file tree
Showing 20 changed files with 60 additions and 44 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/readers.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/sfftk.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
View file
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: 5c838b2f315ffab5dc785519ee4f6e42
config: 2e29a3d6423aa8f47ded5a72362ae136
tags: 645f666f9bcd5a90fca523b33c5a78b7
6 changes: 3 additions & 3 deletions docs/_build/html/annotating.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Annotating EMDB-SFF Segmentations &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>Annotating EMDB-SFF Segmentations &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />
<link rel="next" title="Miscellaneous Operations Using sfftk" href="misc.html" />
<link rel="prev" title="Converting Files To EMDB-SFF" href="converting.html" />

Expand Down
10 changes: 7 additions & 3 deletions docs/_build/html/converting.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Converting Files To EMDB-SFF &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>Converting Files To EMDB-SFF &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,9 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />
<link rel="next" title="Annotating EMDB-SFF Segmentations" href="annotating.html" />
<link rel="prev" title="The EMDB-SFF Toolkit (sfftk)" href="toolkit.html" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
Expand Down Expand Up @@ -361,6 +363,8 @@ <h3><a href="index.html">Table Of Contents</a></h3>
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="toolkit.html" title="previous chapter">The EMDB-SFF Toolkit (sfftk)</a></li>
<li>Next: <a href="annotating.html" title="next chapter">Annotating EMDB-SFF Segmentations</a></li>
</ul></li>
</ul>
</div>
Expand Down
10 changes: 7 additions & 3 deletions docs/_build/html/developing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Developing with sfftk &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>Developing with sfftk &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,9 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />
<link rel="next" title="Extending sfftk" href="extending.html" />
<link rel="prev" title="Miscellaneous Operations Using sfftk" href="misc.html" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
Expand Down Expand Up @@ -628,6 +630,8 @@ <h3><a href="index.html">Table Of Contents</a></h3>
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="misc.html" title="previous chapter">Miscellaneous Operations Using sfftk</a></li>
<li>Next: <a href="extending.html" title="next chapter">Extending sfftk</a></li>
</ul></li>
</ul>
</div>
Expand Down
10 changes: 7 additions & 3 deletions docs/_build/html/extending.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Extending sfftk &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>Extending sfftk &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,9 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />
<link rel="next" title="sfftk packages" href="sfftk.html" />
<link rel="prev" title="Developing with sfftk" href="developing.html" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
Expand Down Expand Up @@ -117,6 +119,8 @@ <h3><a href="index.html">Table Of Contents</a></h3>
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="developing.html" title="previous chapter">Developing with sfftk</a></li>
<li>Next: <a href="sfftk.html" title="next chapter">sfftk packages</a></li>
</ul></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Index &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>Index &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Welcome to sfftk’s documentation! &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>Welcome to sfftk’s documentation! &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="#" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="#" />
<link rel="next" title="The EMDB-SFF Toolkit (sfftk)" href="toolkit.html" />


Expand Down
10 changes: 7 additions & 3 deletions docs/_build/html/misc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Miscellaneous Operations Using sfftk &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>Miscellaneous Operations Using sfftk &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,9 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />
<link rel="next" title="Developing with sfftk" href="developing.html" />
<link rel="prev" title="Annotating EMDB-SFF Segmentations" href="annotating.html" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
Expand Down Expand Up @@ -73,6 +75,8 @@ <h3><a href="index.html">Table Of Contents</a></h3>
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="annotating.html" title="previous chapter">Annotating EMDB-SFF Segmentations</a></li>
<li>Next: <a href="developing.html" title="next chapter">Developing with sfftk</a></li>
</ul></li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/objects.inv
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sphinx inventory version 2
# Project: sfftk
# Version: 0.1.0.dev0
# Version: 0.1.1.dev0
# The remainder of this file is compressed using zlib.
xڭ��R�0��<Ef�k4��-@
�$�JۓF�׶��Hr <}ז ! k� ؎��_����)���g]|��T��K��,s���U�g��ܺ\��~h��T�@��������=�7܋�l���\�q�������?Ո�����7@���"��%A,Ƿ�����E�|[b�]
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/overview.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>sfftk: EMDB-SFF Toolkit &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>sfftk: EMDB-SFF Toolkit &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Python Module Index &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>Python Module Index &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />



Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/readers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>sfftk.readers.amreader package &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>sfftk.readers.amreader package &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Search &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>Search &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/_build/html/sfftk.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>sfftk packages &mdash; sfftk 0.1.0.dev0 documentation</title>
<title>sfftk packages &mdash; sfftk 0.1.1.dev0 documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0.dev0',
VERSION: '0.1.1.dev0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand All @@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="sfftk 0.1.0.dev0 documentation" href="index.html" />
<link rel="top" title="sfftk 0.1.1.dev0 documentation" href="index.html" />
<link rel="prev" title="Extending sfftk" href="extending.html" />


Expand Down
Loading

0 comments on commit b720fcf

Please sign in to comment.