Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
aksnzhy committed Dec 5, 2017
1 parent aa15fd3 commit 5e87879
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 16 deletions.
Binary file modified _build/doctrees/environment.pickle
Binary file not shown.
Binary file modified _build/doctrees/index.doctree
Binary file not shown.
11 changes: 6 additions & 5 deletions _build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,25 @@ Link to the Other Helpful Resources
* See `Installation Guide`__ on how to install xLearn.
* See `Command Line Guide`__ on how to use xLearn command line.
* See `Python API Guide`__ on how to use xLearn Python API.
* See `Demo Page`__ Learning to use xLearn by Examples
* See `Demo Page`__ Learning to use xLearn by Examples.
* See `Tutorial`__ on tutorials on specific tasks.

Quick Install
----------------------------------

We can install xLearn by using pip. The following command will download the xLearn
The easiest way to install xLearn is to use pip. The following command will download the xLearn
source code and build it locally. We will update the xLearn source code on pip weekly. ::

sudo pip install xlearn

Now you can type the following code in python shell to check the installation:
Now you can type the following script in python shell to check whether we install xLearn successfully:

>>> import xlearn as xl
>>> xl.hello()

If you want to build the lastest code on github, or you want to use the xLearn command line,
you can see how to build xLearn from source code from `Installation Guide`__.
If you meet any installation problem, or you want to build the lastest code on github, or you want to
use the xLearn command line instead of the python API, you can see how to build xLearn from source code
in `Installation Guide`__.

Python Demo
----------------------------------
Expand Down
11 changes: 6 additions & 5 deletions _build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,25 +175,26 @@ <h2>Link to the Other Helpful Resources<a class="headerlink" href="#link-to-the-
<li>See <a class="reference external" href="install.html">Installation Guide</a> on how to install xLearn.</li>
<li>See <a class="reference external" href="install.html">Command Line Guide</a> on how to use xLearn command line.</li>
<li>See <a class="reference external" href="command_line.html">Python API Guide</a> on how to use xLearn Python API.</li>
<li>See <a class="reference external" href="python_api.html">Demo Page</a> Learning to use xLearn by Examples</li>
<li>See <a class="reference external" href="python_api.html">Demo Page</a> Learning to use xLearn by Examples.</li>
<li>See <a class="reference external" href="demo.html">Tutorial</a> on tutorials on specific tasks.</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="quick-install">
<h2>Quick Install<a class="headerlink" href="#quick-install" title="Permalink to this headline"></a></h2>
<p>We can install xLearn by using pip. The following command will download the xLearn
<p>The easiest way to install xLearn is to use pip. The following command will download the xLearn
source code and build it locally. We will update the xLearn source code on pip weekly.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">pip</span> <span class="n">install</span> <span class="n">xlearn</span>
</pre></div>
</div>
<p>Now you can type the following code in python shell to check the installation:</p>
<p>Now you can type the following script in python shell to check whether we install xLearn successfully:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">xlearn</span> <span class="k">as</span> <span class="nn">xl</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">xl</span><span class="o">.</span><span class="n">hello</span><span class="p">()</span>
</pre></div>
</div>
<p>If you want to build the lastest code on github, or you want to use the xLearn command line,
you can see how to build xLearn from source code from <a class="reference external" href="tutorial.html">Installation Guide</a>.</p>
<p>If you meet any installation problem, or you want to build the lastest code on github, or you want to
use the xLearn command line instead of the python API, you can see how to build xLearn from source code
in <a class="reference external" href="tutorial.html">Installation Guide</a>.</p>
</div>
<div class="section" id="python-demo">
<h2>Python Demo<a class="headerlink" href="#python-demo" title="Permalink to this headline"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion _build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 6 additions & 5 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,25 @@ Link to the Other Helpful Resources
* See `Installation Guide`__ on how to install xLearn.
* See `Command Line Guide`__ on how to use xLearn command line.
* See `Python API Guide`__ on how to use xLearn Python API.
* See `Demo Page`__ Learning to use xLearn by Examples
* See `Demo Page`__ Learning to use xLearn by Examples.
* See `Tutorial`__ on tutorials on specific tasks.

Quick Install
----------------------------------

We can install xLearn by using pip. The following command will download the xLearn
The easiest way to install xLearn is to use pip. The following command will download the xLearn
source code and build it locally. We will update the xLearn source code on pip weekly. ::

sudo pip install xlearn

Now you can type the following code in python shell to check the installation:
Now you can type the following script in python shell to check whether we install xLearn successfully:

>>> import xlearn as xl
>>> xl.hello()

If you want to build the lastest code on github, or you want to use the xLearn command line,
you can see how to build xLearn from source code from `Installation Guide`__.
If you meet any installation problem, or you want to build the lastest code on github, or you want to
use the xLearn command line instead of the python API, you can see how to build xLearn from source code
in `Installation Guide`__.

Python Demo
----------------------------------
Expand Down

0 comments on commit 5e87879

Please sign in to comment.