Deploying to gh-pages from @ cf752cc 🚀

BiocPy · Nov 11, 2023 · ce9e684 · ce9e684
1 parent ff14c0e
commit ce9e684
Show file tree

Hide file tree

Showing 22 changed files with 1,888 additions and 3,003 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -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: b53936228f1af9acd45a89c0634e3741
+config: d947c8425d53aaddc0e1df344d696ba8
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_modules/biocframe/BiocFrame.html b/_modules/biocframe/BiocFrame.html
diff --git a/_modules/biocframe/Factor.html b/_modules/biocframe/Factor.html
diff --git a/_modules/biocframe/io/from_pandas.html b/_modules/biocframe/io/from_pandas.html
@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
-        <title>biocframe.io.from_pandas - BiocFrame 0.4.1 documentation</title>
+        <title>biocframe.io.from_pandas - BiocFrame 0.5.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -122,7 +122,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">BiocFrame 0.4.1 documentation</div></a>
+      <a href="../../../index.html"><div class="brand">BiocFrame 0.5.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -145,7 +145,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">
 
 
-  <span class="sidebar-brand-text">BiocFrame 0.4.1 documentation</span>
+  <span class="sidebar-brand-text">BiocFrame 0.5.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -209,17 +209,15 @@ <h1>Source code for biocframe.io.from_pandas</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="from_pandas">
 <a class="viewcode-back" href="../../../api/biocframe.io.html#biocframe.io.from_pandas.from_pandas">[docs]</a>
-<span class="k">def</span> <span class="nf">from_pandas</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">BiocFrame</span><span class="p">:</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;Read a :py:class:`~biocframe.BiocFrame.BiocFrame` from a :py:class:`~pandas.DataFrame` object.</span>
+<span class="k">def</span> <span class="nf">from_pandas</span><span class="p">(</span><span class="nb">input</span><span class="p">:</span> <span class="s2">&quot;pandas.DataFrame&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">BiocFrame</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Create a :py:class:`~biocframe.BiocFrame.BiocFrame` from a :py:class:`~pandas.DataFrame` object.</span>
 
 <span class="sd">    Args:</span>
-<span class="sd">        input (:py:class:`~pandas.DataFrame`): Input data.</span>
-
-<span class="sd">    Raises:</span>
-<span class="sd">        TypeError: If ``input`` is not a :py:class:`~pandas.DataFrame`.</span>
+<span class="sd">        input:</span>
+<span class="sd">            Input data.</span>
 
 <span class="sd">    Returns:</span>
-<span class="sd">        BiocFrame: A :py:class:`~biocframe.BiocFrame.BiocFrame` object.</span>
+<span class="sd">        A :py:class:`~biocframe.BiocFrame.BiocFrame` object.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="kn">from</span> <span class="nn">pandas</span> <span class="kn">import</span> <span class="n">DataFrame</span>
@@ -267,7 +265,7 @@ <h1>Source code for biocframe.io.from_pandas</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=c87aa342"></script>
+</div><script src="../../../_static/documentation_options.js?v=1dd76d02"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/_modules/index.html b/_modules/index.html
@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
-        <title>Overview: module code - BiocFrame 0.4.1 documentation</title>
+        <title>Overview: module code - BiocFrame 0.5.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
@@ -122,7 +122,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">BiocFrame 0.4.1 documentation</div></a>
+      <a href="../index.html"><div class="brand">BiocFrame 0.5.0 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -145,7 +145,7 @@
       <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
 
 
-  <span class="sidebar-brand-text">BiocFrame 0.4.1 documentation</span>
+  <span class="sidebar-brand-text">BiocFrame 0.5.0 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -201,7 +201,6 @@
         <article role="main">
           <h1>All modules for which code is available</h1>
 <ul><li><a href="biocframe/BiocFrame.html">biocframe.BiocFrame</a></li>
-<li><a href="biocframe/Factor.html">biocframe.Factor</a></li>
 <li><a href="biocframe/io/from_pandas.html">biocframe.io.from_pandas</a></li>
 </ul>
         </article>
@@ -235,7 +234,7 @@ <h1>All modules for which code is available</h1>
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=c87aa342"></script>
+</div><script src="../_static/documentation_options.js?v=1dd76d02"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/_sources/api/biocframe.rst.txt b/_sources/api/biocframe.rst.txt
@@ -20,30 +20,6 @@ biocframe.BiocFrame module
    :undoc-members:
    :show-inheritance:
 
-biocframe.Factor module
------------------------
-
-.. automodule:: biocframe.Factor
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-biocframe.types module
-----------------------
-
-.. automodule:: biocframe.types
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-biocframe.utils module
-----------------------
-
-.. automodule:: biocframe.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 Module contents
 ---------------
 

diff --git a/_sources/index.md.txt b/_sources/index.md.txt
@@ -1,16 +1,5 @@
 # BiocFrame
 
-This package provides a data-frame representation similar to a pandas `DataFrame`, with
-support for nested column types.
-
-## Install
-
-Package is published to [PyPI](https://pypi.org/project/biocframe/)
-
-```shell
-pip install biocframe
-```
-
 ## Contents
 
 ```{toctree}

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.4.1',
+    VERSION: '0.5.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',