Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@aksnzhy
aksnzhy committed Dec 6, 2017
1 parent 4a51192 commit e9ab023
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 18 deletions.
Binary file modified _build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified _build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified _build/doctrees/install.doctree
View file
Binary file not shown.
4 changes: 2 additions & 2 deletions _build/html/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ xLearn source code and build it locally. We will update the xLearn source code o

sudo pip install xlearn

The installation process will take a while. And then you can type the following script in python
shell to check whether the xLearn has been installed successfully:
The installation process will take a while to complete. And then you can type the following
script in python shell to check whether the xLearn has been installed successfully:

>>> import xlearn as xl
>>> xl.hello()
Expand Down
6 changes: 3 additions & 3 deletions _build/html/_sources/install.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ source code from pip and build it locally. We will update the xLearn source code

sudo pip install xlearn

The installation process will take a while. And then you can type the following script in python
shell to check whether the xLearn has been installed successfully:
The installation process will take a while to complete. And then you can type the following script
in python shell to check whether the xLearn has been installed successfully:

>>> import xlearn as xl
>>> xl.hello()
Expand Down Expand Up @@ -66,4 +66,4 @@ You can also test the python package by using ::
.. toctree::
:hidden:

install_cmake.rst
install_cmake.rst
4 changes: 2 additions & 2 deletions _build/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,8 @@ <h2>Quick Install<a class="headerlink" href="#quick-install" title="Permalink to
<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>The installation process will take a while. And then you can type the following script in python
shell to check whether the xLearn has been installed successfully:</p>
<p>The installation process will take a while to complete. And then you can type the following
script in python shell to check whether the xLearn has been installed 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>
Expand Down
12 changes: 7 additions & 5 deletions _build/html/install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="xLearn 0.1.0 documentation" href="index.html"/>
<link rel="next" title="xLearn Command Line Guide" href="command_line.html"/>
<link rel="next" title="Install GCC or Clang" href="install_cmake.html"/>
<link rel="prev" title="Get Started with xLearn !" href="index.html"/>


Expand Down Expand Up @@ -94,7 +94,9 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#install-xlearn-from-pip">Install xLearn from pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="#install-xlearn-from-source-code">Install xLearn from source code</a></li>
<li class="toctree-l2"><a class="reference internal" href="#test">Test</a><ul class="simple">
<li class="toctree-l2"><a class="reference internal" href="#test">Test</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install_cmake.html">Install GCC or Clang</a></li>
<li class="toctree-l3"><a class="reference internal" href="install_cmake.html#install-cmake">Install CMake</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -181,8 +183,8 @@ <h2>Install xLearn from pip<a class="headerlink" href="#install-xlearn-from-pip"
<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>The installation process will take a while. And then you can type the following script in python
shell to check whether the xLearn has been installed successfully:</p>
<p>The installation process will take a while to complete. And then you can type the following script
in python shell to check whether the xLearn has been installed 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>
Expand Down Expand Up @@ -238,7 +240,7 @@ <h2>Test<a class="headerlink" href="#test" title="Permalink to this headline">¶

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="command_line.html" class="btn btn-neutral float-right" title="xLearn Command Line Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="install_cmake.html" class="btn btn-neutral float-right" title="Install GCC or Clang" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="index.html" class="btn btn-neutral" title="Get Started with xLearn !" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
Expand Down
2 changes: 1 addition & 1 deletion _build/html/searchindex.js
View file

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

4 changes: 2 additions & 2 deletions index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ xLearn source code and build it locally. We will update the xLearn source code o

sudo pip install xlearn

The installation process will take a while. And then you can type the following script in python
shell to check whether the xLearn has been installed successfully:
The installation process will take a while to complete. And then you can type the following
script in python shell to check whether the xLearn has been installed successfully:

>>> import xlearn as xl
>>> xl.hello()
Expand Down
6 changes: 3 additions & 3 deletions install.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ source code from pip and build it locally. We will update the xLearn source code

sudo pip install xlearn

The installation process will take a while. And then you can type the following script in python
shell to check whether the xLearn has been installed successfully:
The installation process will take a while to complete. And then you can type the following script
in python shell to check whether the xLearn has been installed successfully:

>>> import xlearn as xl
>>> xl.hello()
Expand Down Expand Up @@ -66,4 +66,4 @@ You can also test the python package by using ::
.. toctree::
:hidden:

install_cmake.rst
install_cmake.rst

0 comments on commit e9ab023

Please sign in to comment.