auto commit from docs/sphinx/build-docs.sh

docs/sphinx/_build/html/_sources/index.rst.txt

@@ -34,13 +34,16 @@ Project at GitHub_.
 
 .. toctree::
    :maxdepth: 3
+   :hidden:
 
    features
    installing
    using
    birdears
    birdears.questions
 
+.. include:: features.rst
+
 .. include:: installing.rst
 
 .. include:: using.rst

docs/sphinx/_build/html/_sources/using.rst.txt

@@ -334,61 +334,61 @@ Major (Ionian)
 
 .. figure:: _static/img/keybindings/ionian.png
   :scale: 100%
-  :alt: map to buried treasure
+  :alt: birdears keyboard bindings for ionian (major) mode
 
-  This is the caption of the figure (a simple paragraph).
+  Keyboard diagram for the ``--mode major`` (default).
 
 Dorian
 ~~~~~~
 
 .. figure:: _static/img/keybindings/dorian.png
   :scale: 100%
-  :alt: map to buried treasure
+  :alt: birdears keyboard bindings for dorian mode
 
-  This is the caption of the figure (a simple paragraph).
+  Keyboard diagram for the ``--mode dorian``.
 
 Phrygian
 ~~~~~~~~
 
 .. figure:: _static/img/keybindings/phrygian.png
   :scale: 100%
-  :alt: map to buried treasure
+  :alt: birdears keyboard bindings for phrygian mode
 
-  This is the caption of the figure (a simple paragraph).
+  Keyboard diagram for the ``--mode phrygian``.
 
 Lydian
 ~~~~~~
 
 .. figure:: _static/img/keybindings/lydian.png
   :scale: 100%
-  :alt: map to buried treasure
+  :alt: birdears keyboard bindings for lydian mode
 
-  This is the caption of the figure (a simple paragraph).
+  Keyboard diagram for the ``--mode lydian``.
 
 Mixolydian
 ~~~~~~~~~~
 
 .. figure:: _static/img/keybindings/mixolydian.png
   :scale: 100%
-  :alt: map to buried treasure
+  :alt: birdears keyboard bindings for mixolydian mode
 
-  This is the caption of the figure (a simple paragraph).
+  Keyboard diagram for the ``--mode mixolydian``.
 
 Minor (Aeolian)
 ~~~~~~~~~~~~~~~
 
 .. figure:: _static/img/keybindings/minor.png
   :scale: 100%
-  :alt: map to buried treasure
+  :alt: birdears keyboard bindings for aeolian (minor) mode
 
-  This is the caption of the figure (a simple paragraph).
+  Keyboard diagram for the ``--mode minor``.
 
 Locrian
 ~~~~~~~
 
 .. figure:: _static/img/keybindings/locrian.png
   :scale: 100%
-  :alt: map to buried treasure
+  :alt: birdears keyboard bindings for locrian mode
 
-  This is the caption of the figure (a simple paragraph).
+  Keyboard diagram for the ``--mode locrian``.
 

docs/sphinx/_build/html/index.html

@@ -160,71 +160,16 @@ <h1>birdears documentation<a class="headerlink" href="#birdears-documentation" t
 time as you want to try it out.</p>
 <p>Project at <a class="reference external" href="https://github.com/iacchus/birdears">GitHub</a>.</p>
 <div class="toctree-wrapper compound">
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="features.html">Features</a></li>
-<li class="toctree-l1"><a class="reference internal" href="installing.html">Installing birdears</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="installing.html#installing-the-dependencies">Installing the dependencies</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="installing.html#arch-linux">Arch Linux</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="installing.html#id1">Installing birdears</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="installing.html#in-depth-installation">In-depth installation</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="using.html">Using birdears</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="using.html#what-is-functional-ear-training">What is Functional Ear Training</a></li>
-<li class="toctree-l2"><a class="reference internal" href="using.html#the-method">The method</a></li>
-<li class="toctree-l2"><a class="reference internal" href="using.html#birdears-modes-and-basic-usage">birdears modes and basic usage</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="using.html#melodic">melodic</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#harmonic">harmonic</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#dictation">dictation</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#instrumental">instrumental</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="using.html#loading-from-config-preset-files">Loading from config/preset files</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="using.html#pre-made-presets">Pre-made presets</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#creating-new-preset-files">Creating new preset files</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="using.html#keybindings">Keybindings</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="using.html#on-the-keybindings">On the keybindings</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#major-ionian">Major (Ionian)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#dorian">Dorian</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#phrygian">Phrygian</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#lydian">Lydian</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#mixolydian">Mixolydian</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#minor-aeolian">Minor (Aeolian)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="using.html#locrian">Locrian</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="birdears.html">birdears package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="birdears.html#subpackages">Subpackages</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="birdears.interfaces.html">birdears.interfaces package</a></li>
-<li class="toctree-l3"><a class="reference internal" href="birdears.questions.html">birdears.questions package</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.html#submodules">Submodules</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.html#module-birdears.interval">birdears.interval module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.html#module-birdears.logger">birdears.logger module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.html#module-birdears.prequestion">birdears.prequestion module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.html#module-birdears.questionbase">birdears.questionbase module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.html#module-birdears.resolution">birdears.resolution module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.html#module-birdears.scale">birdears.scale module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.html#module-birdears.sequence">birdears.sequence module</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="birdears.questions.html">birdears.questions package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="birdears.questions.html#submodules">Submodules</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.questions.html#module-birdears.questions.harmonicinterval">birdears.questions.harmonicinterval module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.questions.html#module-birdears.questions.instrumentaldictation">birdears.questions.instrumentaldictation module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.questions.html#module-birdears.questions.melodicdictation">birdears.questions.melodicdictation module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="birdears.questions.html#module-birdears.questions.melodicinterval">birdears.questions.melodicinterval module</a></li>
-</ul>
-</li>
+</div>
+<div class="section" id="features">
+<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li>questions</li>
+<li>pretty much configurable</li>
+<li>load from config file</li>
+<li>you can make your own presets</li>
+<li>can be used interactively <em>(docs needed)</em></li>
+<li>can be used as a library <em>(docs needed)</em></li>
 </ul>
 </div>
 <div class="section" id="installing-birdears">
@@ -570,50 +515,50 @@ <h4>On the keybindings<a class="headerlink" href="#on-the-keybindings" title="Pe
 <div class="section" id="major-ionian">
 <h4>Major (Ionian)<a class="headerlink" href="#major-ionian" title="Permalink to this headline">¶</a></h4>
 <div class="figure" id="id14">
-<a class="reference internal image-reference" href="_images/ionian.png"><img alt="map to buried treasure" src="_images/ionian.png" style="width: 614.0px; height: 182.0px;" /></a>
-<p class="caption"><span class="caption-text">This is the caption of the figure (a simple paragraph).</span></p>
+<a class="reference internal image-reference" href="_images/ionian.png"><img alt="birdears keyboard bindings for ionian (major) mode" src="_images/ionian.png" style="width: 614.0px; height: 182.0px;" /></a>
+<p class="caption"><span class="caption-text">Keyboard diagram for the <code class="docutils literal"><span class="pre">--mode</span> <span class="pre">major</span></code> (default).</span></p>
 </div>
 </div>
 <div class="section" id="dorian">
 <h4>Dorian<a class="headerlink" href="#dorian" title="Permalink to this headline">¶</a></h4>
 <div class="figure" id="id15">
-<a class="reference internal image-reference" href="_images/dorian.png"><img alt="map to buried treasure" src="_images/dorian.png" style="width: 614.0px; height: 182.0px;" /></a>
-<p class="caption"><span class="caption-text">This is the caption of the figure (a simple paragraph).</span></p>
+<a class="reference internal image-reference" href="_images/dorian.png"><img alt="birdears keyboard bindings for dorian mode" src="_images/dorian.png" style="width: 614.0px; height: 182.0px;" /></a>
+<p class="caption"><span class="caption-text">Keyboard diagram for the <code class="docutils literal"><span class="pre">--mode</span> <span class="pre">dorian</span></code>.</span></p>
 </div>
 </div>
 <div class="section" id="phrygian">
 <h4>Phrygian<a class="headerlink" href="#phrygian" title="Permalink to this headline">¶</a></h4>
 <div class="figure" id="id16">
-<a class="reference internal image-reference" href="_images/phrygian.png"><img alt="map to buried treasure" src="_images/phrygian.png" style="width: 614.0px; height: 182.0px;" /></a>
-<p class="caption"><span class="caption-text">This is the caption of the figure (a simple paragraph).</span></p>
+<a class="reference internal image-reference" href="_images/phrygian.png"><img alt="birdears keyboard bindings for phrygian mode" src="_images/phrygian.png" style="width: 614.0px; height: 182.0px;" /></a>
+<p class="caption"><span class="caption-text">Keyboard diagram for the <code class="docutils literal"><span class="pre">--mode</span> <span class="pre">phrygian</span></code>.</span></p>
 </div>
 </div>
 <div class="section" id="lydian">
 <h4>Lydian<a class="headerlink" href="#lydian" title="Permalink to this headline">¶</a></h4>
 <div class="figure" id="id17">
-<a class="reference internal image-reference" href="_images/lydian.png"><img alt="map to buried treasure" src="_images/lydian.png" style="width: 614.0px; height: 182.0px;" /></a>
-<p class="caption"><span class="caption-text">This is the caption of the figure (a simple paragraph).</span></p>
+<a class="reference internal image-reference" href="_images/lydian.png"><img alt="birdears keyboard bindings for lydian mode" src="_images/lydian.png" style="width: 614.0px; height: 182.0px;" /></a>
+<p class="caption"><span class="caption-text">Keyboard diagram for the <code class="docutils literal"><span class="pre">--mode</span> <span class="pre">lydian</span></code>.</span></p>
 </div>
 </div>
 <div class="section" id="mixolydian">
 <h4>Mixolydian<a class="headerlink" href="#mixolydian" title="Permalink to this headline">¶</a></h4>
 <div class="figure" id="id18">
-<a class="reference internal image-reference" href="_images/mixolydian.png"><img alt="map to buried treasure" src="_images/mixolydian.png" style="width: 614.0px; height: 182.0px;" /></a>
-<p class="caption"><span class="caption-text">This is the caption of the figure (a simple paragraph).</span></p>
+<a class="reference internal image-reference" href="_images/mixolydian.png"><img alt="birdears keyboard bindings for mixolydian mode" src="_images/mixolydian.png" style="width: 614.0px; height: 182.0px;" /></a>
+<p class="caption"><span class="caption-text">Keyboard diagram for the <code class="docutils literal"><span class="pre">--mode</span> <span class="pre">mixolydian</span></code>.</span></p>
 </div>
 </div>
 <div class="section" id="minor-aeolian">
 <h4>Minor (Aeolian)<a class="headerlink" href="#minor-aeolian" title="Permalink to this headline">¶</a></h4>
 <div class="figure" id="id19">
-<a class="reference internal image-reference" href="_images/minor.png"><img alt="map to buried treasure" src="_images/minor.png" style="width: 614.0px; height: 182.0px;" /></a>
-<p class="caption"><span class="caption-text">This is the caption of the figure (a simple paragraph).</span></p>
+<a class="reference internal image-reference" href="_images/minor.png"><img alt="birdears keyboard bindings for aeolian (minor) mode" src="_images/minor.png" style="width: 614.0px; height: 182.0px;" /></a>
+<p class="caption"><span class="caption-text">Keyboard diagram for the <code class="docutils literal"><span class="pre">--mode</span> <span class="pre">minor</span></code>.</span></p>
 </div>
 </div>
 <div class="section" id="locrian">
 <h4>Locrian<a class="headerlink" href="#locrian" title="Permalink to this headline">¶</a></h4>
 <div class="figure" id="id20">
-<a class="reference internal image-reference" href="_images/locrian.png"><img alt="map to buried treasure" src="_images/locrian.png" style="width: 614.0px; height: 182.0px;" /></a>
-<p class="caption"><span class="caption-text">This is the caption of the figure (a simple paragraph).</span></p>
+<a class="reference internal image-reference" href="_images/locrian.png"><img alt="birdears keyboard bindings for locrian mode" src="_images/locrian.png" style="width: 614.0px; height: 182.0px;" /></a>
+<p class="caption"><span class="caption-text">Keyboard diagram for the <code class="docutils literal"><span class="pre">--mode</span> <span class="pre">locrian</span></code>.</span></p>
 </div>
 </div>
 </div>
@@ -1978,6 +1923,7 @@ <h3>Submodules<a class="headerlink" href="#id13" title="Permalink to this headli
   <h3><a href="#">Table Of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">birdears documentation</a><ul>
+<li><a class="reference internal" href="#features">Features</a></li>
 <li><a class="reference internal" href="#installing-birdears">Installing birdears</a><ul>
 <li><a class="reference internal" href="#installing-the-dependencies">Installing the dependencies</a><ul>
 <li><a class="reference internal" href="#arch-linux">Arch Linux</a></li>