Merge pull request #116 from briancappello/update_html_pages

update the generated html, some style fixes
TA-Lib · Sep 27, 2016 · f56c3ea · f56c3ea
2 parents 21d0d6d + 703dbd5
commit f56c3ea
Show file tree

Hide file tree

Showing 20 changed files with 920 additions and 1,708 deletions.
diff --git a/abstract.html b/abstract.html
diff --git a/doc_index.html b/doc_index.html
@@ -12,15 +12,15 @@
   <body>
     <div id="header_wrap" class="outer">
         <header class="inner">
-            <a id="forkme_banner" href="https://github.com/mrjbq7/ta-lib">Browse TA-Lib on GitHub</a>
+            <a id="forkme_banner" href="https://github.com/mrjbq7/ta-lib">View on GitHub</a>
             <div class="clearfix">
                 <ul id="menu" class="drop">
                     <li><a href="index.html">Home</a></li>
                     <li><a href="doc_index.html">Documentation</a></li>
                 </ul>
             </div>
             <br>
-            <h1 id="project_title">TA-Lib</h1>
+            <h1 id="project_title"><a href="http://mrjbq7.github.io/ta-lib/">TA-Lib</a></h1>
             <h2 id="project_tagline">Python wrapper for TA-Lib (http://ta-lib.org/).</h2>
             <section id="downloads">
                 <a class="zip_download_link" href="https://github.com/mrjbq7/ta-lib/zipball/master">Download this project as a .zip file</a>
@@ -32,16 +32,12 @@ <h2 id="project_tagline">Python wrapper for TA-Lib (http://ta-lib.org/).</h2>
     <!-- MAIN CONTENT -->
     <div id="main_content_wrap" class="outer">
         <section id="main_content" class="inner">
-<a id="user-content-documentation" class="anchor" href="#documentation" aria-hidden="true"><span class="octicon octicon-link"></span></a>Documentation</h1>
-
+<h1>Documentation</h1>
 <ul>
 <li><a href="install.html">Installation and Troubleshooting</a></li>
 <li><a href="func.html">Using the Function API</a></li>
 <li><a href="abstract.html">Using the Abstract API</a></li>
-<li>
-<a href="funcs.html">All Functions</a>
-
-<ul>
+<li><a href="funcs.html">All Functions</a><ul>
 <li><a href="func_groups/overlap_studies.html">Overlap Studies</a></li>
 <li><a href="func_groups/momentum_indicators.html">Momentum Indicators</a></li>
 <li><a href="func_groups/volume_indicators.html">Volume Indicators</a></li>
@@ -54,15 +50,15 @@ <h2 id="project_tagline">Python wrapper for TA-Lib (http://ta-lib.org/).</h2>
 <li><a href="func_groups/math_operators.html">Math Operators</a></li>
 </ul>
 </li>
-</ul>        </section>
+</ul>
+        </section>
     </div>
 
     <!-- FOOTER  -->
     <div id="footer_wrap" class="outer">
       <footer class="inner">
         <p class="copyright">TA-Lib written by <a href="https://github.com/mrjbq7">mrjbq7</a>
-        with contributions by <a href="https://github.com/briancappello">briancappello</a>
-        and <a href="https://github.com/mrjbq7/ta-lib/network/members">others</a></p>
+        and <a href="https://github.com/mrjbq7/ta-lib/network/members">contributors</a></p>
 
         <p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
       </footer>

diff --git a/func.html b/func.html
@@ -12,15 +12,15 @@
   <body>
     <div id="header_wrap" class="outer">
         <header class="inner">
-            <a id="forkme_banner" href="https://github.com/mrjbq7/ta-lib">Browse TA-Lib on GitHub</a>
+            <a id="forkme_banner" href="https://github.com/mrjbq7/ta-lib">View on GitHub</a>
             <div class="clearfix">
                 <ul id="menu" class="drop">
                     <li><a href="index.html">Home</a></li>
                     <li><a href="doc_index.html">Documentation</a></li>
                 </ul>
             </div>
             <br>
-            <h1 id="project_title">TA-Lib</h1>
+            <h1 id="project_title"><a href="http://mrjbq7.github.io/ta-lib/">TA-Lib</a></h1>
             <h2 id="project_tagline">Python wrapper for TA-Lib (http://ta-lib.org/).</h2>
             <section id="downloads">
                 <a class="zip_download_link" href="https://github.com/mrjbq7/ta-lib/zipball/master">Download this project as a .zip file</a>
@@ -32,39 +32,31 @@ <h2 id="project_tagline">Python wrapper for TA-Lib (http://ta-lib.org/).</h2>
     <!-- MAIN CONTENT -->
     <div id="main_content_wrap" class="outer">
         <section id="main_content" class="inner">
-<a id="user-content-function-api-examples" class="anchor" href="#function-api-examples" aria-hidden="true"><span class="octicon octicon-link"></span></a>Function API Examples</h1>
-
+<h1>Function API Examples</h1>
 <p>Similar to TA-Lib, the function interface provides a lightweight wrapper of
 the exposed TA-Lib indicators.</p>
-
 <p>Each function returns an output array and have default values for their
 parameters, unless specified as keyword arguments. Typically, these functions
 will have an initial "lookback" period (a required number of observations
 before an output is generated) set to <code>NaN</code>.</p>
-
 <p>All of the following examples use the function API:</p>
+<div class="highlight"><pre><span></span><span class="highlight kn">import</span> <span class="highlight nn">numpy</span>
+<span class="highlight kn">import</span> <span class="highlight nn">talib</span>
 
-<div class="highlight highlight-python"><pre><span class="pl-k">import</span> numpy
-<span class="pl-k">import</span> talib
-
-close <span class="pl-k">=</span> numpy.random.random(<span class="pl-c1">100</span>)</pre></div>
-
+<span class="highlight n">close</span> <span class="highlight o">=</span> <span class="highlight n">numpy</span><span class="highlight o">.</span><span class="highlight n">random</span><span class="highlight o">.</span><span class="highlight n">random</span><span class="highlight p">(</span><span class="highlight mi">100</span><span class="highlight p">)</span>
+</pre></div>
 <p>Calculate a simple moving average of the close prices:</p>
-
-<div class="highlight highlight-python"><pre>output <span class="pl-k">=</span> talib.SMA(close)</pre></div>
-
+<div class="highlight"><pre><span></span><span class="highlight n">output</span> <span class="highlight o">=</span> <span class="highlight n">talib</span><span class="highlight o">.</span><span class="highlight n">SMA</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
+</pre></div>
 <p>Calculating bollinger bands, with triple exponential moving average:</p>
+<div class="highlight"><pre><span></span><span class="highlight kn">from</span> <span class="highlight nn">talib</span> <span class="highlight kn">import</span> <span class="highlight n">MA_Type</span>
 
-<div class="highlight highlight-python"><pre><span class="pl-k">from</span> talib <span class="pl-k">import</span> MA_Type
-
-upper, middle, lower <span class="pl-k">=</span> talib.BBANDS(close, <span class="pl-smi">matype</span><span class="pl-k">=</span>MA_Type.T3)</pre></div>
-
+<span class="highlight n">upper</span><span class="highlight p">,</span> <span class="highlight n">middle</span><span class="highlight p">,</span> <span class="highlight n">lower</span> <span class="highlight o">=</span> <span class="highlight n">talib</span><span class="highlight o">.</span><span class="highlight n">BBANDS</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">,</span> <span class="highlight n">matype</span><span class="highlight o">=</span><span class="highlight n">MA_Type</span><span class="highlight o">.</span><span class="highlight n">T3</span><span class="highlight p">)</span>
+</pre></div>
 <p>Calculating momentum of the close prices, with a time period of 5:</p>
-
-<div class="highlight highlight-python"><pre>output <span class="pl-k">=</span> talib.MOM(close, <span class="pl-smi">timeperiod</span><span class="pl-k">=</span><span class="pl-c1">5</span>)</pre></div>
-
+<div class="highlight"><pre><span></span><span class="highlight n">output</span> <span class="highlight o">=</span> <span class="highlight n">talib</span><span class="highlight o">.</span><span class="highlight n">MOM</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">,</span> <span class="highlight n">timeperiod</span><span class="highlight o">=</span><span class="highlight mi">5</span><span class="highlight p">)</span>
+</pre></div>
 <p>Documentation for all functions:</p>
-
 <ul>
 <li><a href="func_groups/overlap_studies.html">Overlap Studies</a></li>
 <li><a href="func_groups/momentum_indicators.html">Momentum Indicators</a></li>
@@ -77,17 +69,16 @@ <h2 id="project_tagline">Python wrapper for TA-Lib (http://ta-lib.org/).</h2>
 <li><a href="func_groups/math_transform.html">Math Transform</a></li>
 <li><a href="func_groups/math_operators.html">Math Operators</a></li>
 </ul>
-
 <p><a href="doc_index.html">Documentation Index</a>
-<a class="float-right" href="abstract.html">Next: Using the Abstract API</a></p>        </section>
+<a class="float-right" href="abstract.html">Next: Using the Abstract API</a></p>
+        </section>
     </div>
 
     <!-- FOOTER  -->
     <div id="footer_wrap" class="outer">
       <footer class="inner">
         <p class="copyright">TA-Lib written by <a href="https://github.com/mrjbq7">mrjbq7</a>
-        with contributions by <a href="https://github.com/briancappello">briancappello</a>
-        and <a href="https://github.com/mrjbq7/ta-lib/network/members">others</a></p>
+        and <a href="https://github.com/mrjbq7/ta-lib/network/members">contributors</a></p>
 
         <p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
       </footer>

diff --git a/func_groups/cycle_indicators.html b/func_groups/cycle_indicators.html
@@ -12,15 +12,15 @@
   <body>
     <div id="header_wrap" class="outer">
         <header class="inner">
-            <a id="forkme_banner" href="https://github.com/mrjbq7/ta-lib">Browse TA-Lib on GitHub</a>
+            <a id="forkme_banner" href="https://github.com/mrjbq7/ta-lib">View on GitHub</a>
             <div class="clearfix">
                 <ul id="menu" class="drop">
                     <li><a href="../index.html">Home</a></li>
                     <li><a href="../doc_index.html">Documentation</a></li>
                 </ul>
             </div>
             <br>
-            <h1 id="project_title">TA-Lib</h1>
+            <h1 id="project_title"><a href="http://mrjbq7.github.io/ta-lib/">TA-Lib</a></h1>
             <h2 id="project_tagline">Python wrapper for TA-Lib (http://ta-lib.org/).</h2>
             <section id="downloads">
                 <a class="zip_download_link" href="https://github.com/mrjbq7/ta-lib/zipball/master">Download this project as a .zip file</a>
@@ -32,58 +32,42 @@ <h2 id="project_tagline">Python wrapper for TA-Lib (http://ta-lib.org/).</h2>
     <!-- MAIN CONTENT -->
     <div id="main_content_wrap" class="outer">
         <section id="main_content" class="inner">
-<a id="user-content-cycle-indicator-functions" class="anchor" href="#cycle-indicator-functions" aria-hidden="true"><span class="octicon octicon-link"></span></a>Cycle Indicator Functions</h1>
-
-<h3>
-<a id="user-content-ht_dcperiod---hilbert-transform---dominant-cycle-period" class="anchor" href="#ht_dcperiod---hilbert-transform---dominant-cycle-period" aria-hidden="true"><span class="octicon octicon-link"></span></a>HT_DCPERIOD - Hilbert Transform - Dominant Cycle Period</h3>
-
-<pre>real = HT_DCPERIOD(close)
-</pre>
-
-<p>Learn more about the Hilbert Transform - Dominant Cycle Period at <a href="http://www.tadoc.org/indicator/HT_DCPERIOD.htm">tadoc.org</a>.  </p>
-
-<h3>
-<a id="user-content-ht_dcphase---hilbert-transform---dominant-cycle-phase" class="anchor" href="#ht_dcphase---hilbert-transform---dominant-cycle-phase" aria-hidden="true"><span class="octicon octicon-link"></span></a>HT_DCPHASE - Hilbert Transform - Dominant Cycle Phase</h3>
-
-<pre>real = HT_DCPHASE(close)
-</pre>
-
-<p>Learn more about the Hilbert Transform - Dominant Cycle Phase at <a href="http://www.tadoc.org/indicator/HT_DCPHASE.htm">tadoc.org</a>.  </p>
-
-<h3>
-<a id="user-content-ht_phasor---hilbert-transform---phasor-components" class="anchor" href="#ht_phasor---hilbert-transform---phasor-components" aria-hidden="true"><span class="octicon octicon-link"></span></a>HT_PHASOR - Hilbert Transform - Phasor Components</h3>
-
-<pre>inphase, quadrature = HT_PHASOR(close)
-</pre>
-
-<p>Learn more about the Hilbert Transform - Phasor Components at <a href="http://www.tadoc.org/indicator/HT_PHASOR.htm">tadoc.org</a>.  </p>
-
-<h3>
-<a id="user-content-ht_sine---hilbert-transform---sinewave" class="anchor" href="#ht_sine---hilbert-transform---sinewave" aria-hidden="true"><span class="octicon octicon-link"></span></a>HT_SINE - Hilbert Transform - SineWave</h3>
-
-<pre>sine, leadsine = HT_SINE(close)
-</pre>
-
-<p>Learn more about the Hilbert Transform - SineWave at <a href="http://www.tadoc.org/indicator/HT_SINE.htm">tadoc.org</a>.  </p>
-
-<h3>
-<a id="user-content-ht_trendmode---hilbert-transform---trend-vs-cycle-mode" class="anchor" href="#ht_trendmode---hilbert-transform---trend-vs-cycle-mode" aria-hidden="true"><span class="octicon octicon-link"></span></a>HT_TRENDMODE - Hilbert Transform - Trend vs Cycle Mode</h3>
-
-<pre>integer = HT_TRENDMODE(close)
-</pre>
-
-<p>Learn more about the Hilbert Transform - Trend vs Cycle Mode at <a href="http://www.tadoc.org/indicator/HT_TRENDMODE.htm">tadoc.org</a>.  </p>
-
+<h1>Cycle Indicator Functions</h1>
+<h3>HT_DCPERIOD - Hilbert Transform - Dominant Cycle Period</h3>
+<p>NOTE: The <code>HT_DCPERIOD</code> function has an unstable period.</p>
+<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">HT_DCPERIOD</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
+</pre></div>
+<p>Learn more about the Hilbert Transform - Dominant Cycle Period at <a href="http://www.tadoc.org/indicator/HT_DCPERIOD.htm">tadoc.org</a>.</p>
+<h3>HT_DCPHASE - Hilbert Transform - Dominant Cycle Phase</h3>
+<p>NOTE: The <code>HT_DCPHASE</code> function has an unstable period.</p>
+<div class="highlight"><pre><span></span><span class="highlight n">real</span> <span class="highlight o">=</span> <span class="highlight n">HT_DCPHASE</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
+</pre></div>
+<p>Learn more about the Hilbert Transform - Dominant Cycle Phase at <a href="http://www.tadoc.org/indicator/HT_DCPHASE.htm">tadoc.org</a>.</p>
+<h3>HT_PHASOR - Hilbert Transform - Phasor Components</h3>
+<p>NOTE: The <code>HT_PHASOR</code> function has an unstable period.</p>
+<div class="highlight"><pre><span></span><span class="highlight n">inphase</span><span class="highlight p">,</span> <span class="highlight n">quadrature</span> <span class="highlight o">=</span> <span class="highlight n">HT_PHASOR</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
+</pre></div>
+<p>Learn more about the Hilbert Transform - Phasor Components at <a href="http://www.tadoc.org/indicator/HT_PHASOR.htm">tadoc.org</a>.</p>
+<h3>HT_SINE - Hilbert Transform - SineWave</h3>
+<p>NOTE: The <code>HT_SINE</code> function has an unstable period.</p>
+<div class="highlight"><pre><span></span><span class="highlight n">sine</span><span class="highlight p">,</span> <span class="highlight n">leadsine</span> <span class="highlight o">=</span> <span class="highlight n">HT_SINE</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
+</pre></div>
+<p>Learn more about the Hilbert Transform - SineWave at <a href="http://www.tadoc.org/indicator/HT_SINE.htm">tadoc.org</a>.</p>
+<h3>HT_TRENDMODE - Hilbert Transform - Trend vs Cycle Mode</h3>
+<p>NOTE: The <code>HT_TRENDMODE</code> function has an unstable period.</p>
+<div class="highlight"><pre><span></span><span class="highlight n">integer</span> <span class="highlight o">=</span> <span class="highlight n">HT_TRENDMODE</span><span class="highlight p">(</span><span class="highlight n">close</span><span class="highlight p">)</span>
+</pre></div>
+<p>Learn more about the Hilbert Transform - Trend vs Cycle Mode at <a href="http://www.tadoc.org/indicator/HT_TRENDMODE.htm">tadoc.org</a>.</p>
 <p><a href="../doc_index.html">Documentation Index</a>
-<a class="float-right" href="../funcs.html">All Function Groups</a></p>        </section>
+<a class="float-right" href="../funcs.html">All Function Groups</a></p>
+        </section>
     </div>
 
     <!-- FOOTER  -->
     <div id="footer_wrap" class="outer">
       <footer class="inner">
         <p class="copyright">TA-Lib written by <a href="https://github.com/mrjbq7">mrjbq7</a>
-        with contributions by <a href="https://github.com/briancappello">briancappello</a>
-        and <a href="https://github.com/mrjbq7/ta-lib/network/members">others</a></p>
+        and <a href="https://github.com/mrjbq7/ta-lib/network/members">contributors</a></p>
 
         <p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
       </footer>