update mddocs/user_guide/getting_started.md

monitor1379 · Nov 26, 2016 · e1e9892 · e1e9892
1 parent a2de909
commit e1e9892
Show file tree

Hide file tree

Showing 18 changed files with 772 additions and 130 deletions.
diff --git a/docs/about/contributing/index.html b/docs/about/contributing/index.html
@@ -61,6 +61,12 @@
                     <ul class="dropdown-menu">
 
 
+<li >
+    <a href="../../user_guide/installation/">Installation</a>
+</li>
+
+
+
 <li >
     <a href="../../user_guide/getting_started/">Getting Started</a>
 </li>

diff --git a/docs/about/license/index.html b/docs/about/license/index.html
@@ -61,6 +61,12 @@
                     <ul class="dropdown-menu">
 
 
+<li >
+    <a href="../../user_guide/installation/">Installation</a>
+</li>
+
+
+
 <li >
     <a href="../../user_guide/getting_started/">Getting Started</a>
 </li>

diff --git a/docs/about/release_notes/index.html b/docs/about/release_notes/index.html
@@ -61,6 +61,12 @@
                     <ul class="dropdown-menu">
 
 
+<li >
+    <a href="../../user_guide/installation/">Installation</a>
+</li>
+
+
+
 <li >
     <a href="../../user_guide/getting_started/">Getting Started</a>
 </li>

diff --git a/docs/api/sophon/API/index.html b/docs/api/sophon/API/index.html
@@ -61,6 +61,12 @@
                     <ul class="dropdown-menu">
 
 
+<li >
+    <a href="../../../user_guide/installation/">Installation</a>
+</li>
+
+
+
 <li >
     <a href="../../../user_guide/getting_started/">Getting Started</a>
 </li>
@@ -187,34 +193,34 @@ <h1 id="api-documentations-of-sophon">API documentations of Sophon</h1>
 <h1 id="sophonparserspy">sophon/parsers.py</h1>
 <p><span style="float:right;"><a href="https://github.com/monitor1379/sophon/blob/master/sophon/parsers.py#L10">[source]</a></span></p>
 <h2 id="parser">Parser</h2>
-<pre><code class="python">sophon.parsers.Parser.Parser()
+<pre><code class="python">sophon.parsers.Parser()
 </code></pre>
 
 <p>Top level base class of parsers.</p>
 <hr />
 <p><span style="float:right;"><a href="https://github.com/monitor1379/sophon/blob/master/sophon/parsers.py#L155">[source]</a></span></p>
 <h2 id="restructuredtextparser">ReStructuredTextParser</h2>
-<pre><code class="python">sophon.parsers.ReStructuredTextParser.ReStructuredTextParser()
+<pre><code class="python">sophon.parsers.ReStructuredTextParser()
 </code></pre>
 
 <p>Support soon.</p>
 <hr />
 <p><span style="float:right;"><a href="https://github.com/monitor1379/sophon/blob/master/sophon/parsers.py#L178">[source]</a></span></p>
 <h2 id="googledocparser">GoogleDocParser</h2>
-<pre><code class="python">sophon.parsers.GoogleDocParser.GoogleDocParser()
+<pre><code class="python">sophon.parsers.GoogleDocParser()
 </code></pre>
 
 <p>Support soon.</p>
 <hr />
 <p><span style="float:right;"><a href="https://github.com/monitor1379/sophon/blob/master/sophon/parsers.py#L201">[source]</a></span></p>
 <h2 id="numpydocparser">NumPyDocParser</h2>
-<pre><code class="python">sophon.parsers.NumPyDocParser.NumPyDocParser()
+<pre><code class="python">sophon.parsers.NumPyDocParser()
 </code></pre>
 
 <p>Support soon.</p>
 <hr />
 <h2 id="sophonparser">SophonParser</h2>
-<pre><code class="python">sophon.parsers.SophonParser.SophonParser()
+<pre><code class="python">sophon.parsers.SophonParser()
 </code></pre>
 
 <p>A docstring parser for parsing Sophon style docstring to Markdown.</p>
@@ -430,9 +436,9 @@ <h2 id="generate_repo_link">generate_repo_link</h2>
 </ul>
 <hr />
 <h1 id="sophonbuildpy">sophon/build.py</h1>
-<p><span style="float:right;"><a href="https://github.com/monitor1379/sophon/blob/master/sophon/build.py#L25">[source]</a></span></p>
+<p><span style="float:right;"><a href="https://github.com/monitor1379/sophon/blob/master/sophon/cmd/build.py#L26">[source]</a></span></p>
 <h2 id="build_from_yaml">build_from_yaml</h2>
-<pre><code class="python">sophon.build.build_from_yaml(config_fn)
+<pre><code class="python">sophon.cmd.build.build_from_yaml(config_fn)
 </code></pre>
 
 <p>Build documentations of python project given the configuration filename.</p>

diff --git a/docs/index.html b/docs/index.html
@@ -61,6 +61,12 @@
                     <ul class="dropdown-menu">
 
 
+<li >
+    <a href="user_guide/installation/">Installation</a>
+</li>
+
+
+
 <li >
     <a href="user_guide/getting_started/">Getting Started</a>
 </li>
@@ -130,7 +136,7 @@
                     </a>
                 </li>
                 <li >
-                    <a rel="prev" href="user_guide/getting_started/">
+                    <a rel="prev" href="user_guide/installation/">
                         Next <i class="fa fa-arrow-right"></i>
                     </a>
                 </li>
@@ -261,7 +267,8 @@ <h2 id="why-sophon">Why Sophon?</h2>
     you only need one command to build you API documentation.</p>
 </li>
 </ul>
-<p>You can find more details in <strong>User Guide</strong>.</p>
+<p>You can find more details in <strong><a href="user_guide/installation/">User Guide/Installation</a></strong> or
+<strong><a href="user_guide/getting_started/">User Guide/Getting Started</a></strong>.</p>
 <h2 id="what-does-sophon-mean">What does "Sophon" mean?</h2>
 <p><strong>Sophon</strong> is the official translation of "<strong>智子</strong>" in 《Rememberance of Earth's Past II: The Dark Forest》
 which is written by the famous Chinese science fiction writer named <strong>Cixin Liu(刘慈欣)</strong>.</p>