deploy: cf2b09c

audeering · Jan 10, 2024 · 5b89331 · 5b89331
1 parent 36a8c9e
commit 5b89331
Show file tree

Hide file tree

Showing 20 changed files with 55 additions and 38 deletions.
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/usage.doctree b/.doctrees/usage.doctree
diff --git a/_modules/audb/core/api.html b/_modules/audb/core/api.html
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/_modules/audb/core/repository.html b/_modules/audb/core/repository.html
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/_modules/index.html b/_modules/index.html
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/_sources/usage.rst.txt b/_sources/usage.rst.txt
@@ -68,32 +68,23 @@ to specify how classes are rendered.
 You will need to add ``templates_path = ["_templates"]``
 to your sphinx_ config file
 (e.g. ``docs/conf.py``).
-
 Inside the template you can access the ``apipages_hidden_methods`` list
 by ``hidden_methods``.
-The default template for classes is:
 
-.. code-block:: rst
+The default templates for classes is ``autosummary/class.rst``:
+
+.. literalinclude:: ../sphinx_apipages/templates/autosummary/class.rst
+    :language: rst
 
-    {{ objname | escape | underline}}
+The default template for functions is ``autosummary/function.rst``:
 
-    .. currentmodule:: {{ module }}
+.. literalinclude:: ../sphinx_apipages/templates/autosummary/function.rst
+    :language: rst
 
-    .. autoclass:: {{ objname }}
+The default template otherwise is ``autosummary/base.rst``:
 
-    {% block methods %}
-    {%- for item in (all_methods + attributes)|sort %}
-        {%- if not item.startswith('_') or item in hidden_methods %}
-            {%- if item in all_methods %}
-    {{ (item + '()') | escape | underline(line='-') }}
-    .. automethod:: {{ name }}.{{ item }}
-            {%- elif item in attributes %}
-    {{ item | escape | underline(line='-') }}
-    .. autoattribute:: {{ name }}.{{ item }}
-            {%- endif %}
-        {% endif %}
-    {%- endfor %}
-    {% endblock %}
+.. literalinclude:: ../sphinx_apipages/templates/autosummary/base.rst
+    :language: rst
 
 
 .. _sphinx: https://www.sphinx-doc.org

diff --git a/api/audb.Repository.html b/api/audb.Repository.html
@@ -65,7 +65,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/api/audb.html b/api/audb.html
@@ -65,7 +65,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/api/audb.repository.html b/api/audb.repository.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/changelog.html b/changelog.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 
@@ -102,6 +102,7 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#version-0-1-1-2024-01-10">Version 0.1.1 (2024-01-10)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-1-0-2024-01-10">Version 0.1.0 (2024-01-10)</a></li>
 </ul>
 </li>
@@ -146,6 +147,15 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
 <p>All notable changes to this project will be documented in this file.</p>
 <p>The format is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
 and this project adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
+<div class="section" id="version-0-1-1-2024-01-10">
+<h2>Version 0.1.1 (2024-01-10)<a class="headerlink" href="#version-0-1-1-2024-01-10" title="Permalink to this heading">¶</a></h2>
+<ul class="simple">
+<li><p>Added: document all default autosummary templates</p></li>
+<li><p>Fixed: handling of custom <code class="docutils literal notranslate"><span class="pre">templates_path</span></code>
+config entries
+when no templates are provided</p></li>
+</ul>
+</div>
 <div class="section" id="version-0-1-0-2024-01-10">
 <h2>Version 0.1.0 (2024-01-10)<a class="headerlink" href="#version-0-1-0-2024-01-10" title="Permalink to this heading">¶</a></h2>
 <ul class="simple">

diff --git a/contributing.html b/contributing.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/genindex.html b/genindex.html
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/index.html b/index.html
@@ -64,7 +64,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/install.html b/install.html
@@ -65,7 +65,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/objects.inv b/objects.inv
diff --git a/py-modindex.html b/py-modindex.html
@@ -70,7 +70,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/search.html b/search.html
@@ -63,7 +63,7 @@
 
 
               <div class="version">
-                v0.1.0
+                v0.1.1
               </div>
 
 

diff --git a/searchindex.js b/searchindex.js
-Original file line number
+Diff line change
@@ Expand Up / @@ -63,7 +63,7 @@ @@
                   <div class="version">
-                    v0.1.0
+                    v0.1.1
                   </div>
@@ Expand Down @@