| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>How to write doc in local — go-chassis documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <script type="text/javascript" src="_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> go-chassis |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <p class="caption"><span class="caption-text">User Documentations</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="intro.html">Introductions</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="get-started.html">Get started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="configuration.html">User guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="development.html">Development guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="protocols.html">Protocols</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="istio-guides.html">Use Istio as control plane</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="sidecar.html">Sidcar-injector Deployment and Usage</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">go-chassis</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li>How to write doc in local</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/README.md.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="how-to-write-doc-in-local"> |
| <h1>How to write doc in local<a class="headerlink" href="#how-to-write-doc-in-local" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="prepare"> |
| <h2>Prepare<a class="headerlink" href="#prepare" title="Permalink to this headline">¶</a></h2> |
| <ol class="simple"> |
| <li><p>Install Python 2.7 with zlib, libssl-dev(openssl-devel)</p></li> |
| <li><p>Install pip</p></li> |
| <li><p>Install readthe doc support https://docs.readthedocs.io/en/latest/getting_started.html</p></li> |
| <li><p>Install RTD module</p></li> |
| </ol> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>sudo pip install sphinx_rtd_theme |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="generate-doc"> |
| <h2>Generate doc<a class="headerlink" href="#generate-doc" title="Permalink to this headline">¶</a></h2> |
| <p>In windows</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> docs |
| make.bat html |
| </pre></div> |
| </div> |
| <p>In linux</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> docs |
| sphinx-autobuild . _build/html |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="check-the-result"> |
| <h2>Check the result<a class="headerlink" href="#check-the-result" title="Permalink to this headline">¶</a></h2> |
| <ol class="simple"> |
| <li><p>See html pages in _build folder</p></li> |
| <li><p>Access http://127.0.0.1:8000</p></li> |
| </ol> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2018, xiaoliang |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
