write_docs_en.html



<!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>Contribute Documentation &mdash; PaddlePaddle  documentation</title>
  

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

        <link rel="index" title="Index"
              href="../genindex.html"/>
        <link rel="search" title="Search" href="../search.html"/>
    <link rel="top" title="PaddlePaddle  documentation" href="../index.html"/>
        <link rel="up" title="Development" href="index_en.html"/>
        <link rel="next" title="FAQ" href="../faq/index_en.html"/>
        <link rel="prev" title="Contribute Code" href="contribute_to_paddle_en.html"/> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <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_en.html" class="icon icon-home"> PaddlePaddle
          

          </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">
          
            
                <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../getstarted/index_en.html">GET STARTED</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_and_install/index_en.html">Install and Build</a></li>
<li class="toctree-l1"><a class="reference internal" href="../howto/index_en.html">HOW TO</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index_en.html">Development</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="contribute_to_paddle_en.html">Contribute Code</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Contribute Documentation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#how-to-build-documentations">How to Build Documentations</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#use-paddlepaddle-org-tool">Use PaddlePaddle.org tool</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#how-to-write-documentations">How to write Documentations</a></li>
<li class="toctree-l3"><a class="reference internal" href="#how-to-update-www-paddlepaddle-org">How to update www.paddlepaddle.org</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../faq/index_en.html">FAQ</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../index_en.html">PaddlePaddle</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_en.html">Docs</a> &raquo;</li>
      
          <li><a href="index_en.html">Development</a> &raquo;</li>
      
    <li>Contribute Documentation</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/dev/write_docs_en.rst.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="contribute-documentation">
<h1>Contribute Documentation<a class="headerlink" href="#contribute-documentation" title="Permalink to this headline">¶</a></h1>
<p>PaddlePaddle supports English documentation <code class="docutils literal"><span class="pre">doc</span></code> and Chinese documentation <code class="docutils literal"><span class="pre">doc_cn</span></code>.
Both are compiled by <a class="reference external" href="https://cmake.org/">cmake</a> and <a class="reference external" href="http://www.sphinx-doc.org/en/1.4.8/">sphinx</a> , the compiled documentations will be stored under <code class="docutils literal"><span class="pre">doc</span></code> and <code class="docutils literal"><span class="pre">doc_cn</span></code> directories.
When using the PaddlePaddle.org to compile documentations, the compiled documentations will be stored under a consolidated directory: .ppo_workspace/content</p>
<div class="section" id="how-to-build-documentations">
<h2>How to Build Documentations<a class="headerlink" href="#how-to-build-documentations" title="Permalink to this headline">¶</a></h2>
<p>We recommend using PaddlePaddle.org tool to build documentation</p>
<div class="section" id="use-paddlepaddle-org-tool">
<h3>Use PaddlePaddle.org tool<a class="headerlink" href="#use-paddlepaddle-org-tool" title="Permalink to this headline">¶</a></h3>
<p>This is the recommended method to build documentation. It can compile documentation and preview the documentation in a web browser.</p>
<p>The tool uses Docker, please install it on your system. Please check Docker official website on how to install Docker. You may use the following commands to activate the tool</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>mkdir paddlepaddle <span class="c1"># Create paddlepaddle working directory</span>
<span class="nb">cd</span> paddlepaddle

<span class="c1"># Clone the content repositories. You may only clone the contents you need</span>
git clone https://github.com/PaddlePaddle/Paddle.git
git clone https://github.com/PaddlePaddle/book.git
git clone https://github.com/PaddlePaddle/models.git
git clone https://github.com/PaddlePaddle/Mobile.git

<span class="c1"># Please specify the working directory through -v</span>
docker run -it -p <span class="m">8000</span>:8000 -v <span class="sb">`</span><span class="nb">pwd</span><span class="sb">`</span>:/var/content paddlepaddle/paddlepaddle.org:latest
</pre></div>
</div>
<p>Note: PaddlePaddle.org will read the content repos specified in the -v (volume) flag of the docker run command
Use a web browser and navigate to <a class="reference external" href="http://localhost:8000">http://localhost:8000</a>, click the buttons to compile the documentation
The compiled documentations will be stored in &lt;paddlepaddle working directory&gt;/.ppo_workspace/content</p>
<p>If you don&#8217;t wish to use Docker, you can also activate the tool through Django. Use the following the commands to set up</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>mkdir paddlepaddle <span class="c1"># Create paddlepaddle working directory</span>
<span class="nb">cd</span> paddlepaddle

<span class="c1"># Clone the content repositories and PaddlePaddle.org</span>
git clone https://github.com/PaddlePaddle/Paddle.git
git clone https://github.com/PaddlePaddle/book.git
git clone https://github.com/PaddlePaddle/models.git
git clone https://github.com/PaddlePaddle/Mobile.git
git clone https://github.com/PaddlePaddle/PaddlePaddle.org.git

<span class="c1"># Please specify the PaddlePaddle working directory. In the current setting, it should be pwd</span>
<span class="nb">export</span> <span class="nv">CONTENT_DIR</span><span class="o">=</span>&lt;path_to_paddlepaddle_working_directory&gt;
<span class="nb">export</span> <span class="nv">ENV</span><span class="o">=</span><span class="s1">&#39;&#39;</span>
<span class="nb">cd</span> PaddlePaddle.org/portal/
pip install -r requirements.txt
python manage.py runserver
</pre></div>
</div>
<p>Use a web browser and navigate to <a class="reference external" href="http://localhost:8000">http://localhost:8000</a>, click the buttons to compile the documentation
The compiled documentations will be stored in &lt;paddlepaddle working directory&gt;/.ppo_workspace/content</p>
<p>If you want to learn more on the PaddlePaddle.org, please <a class="reference external" href="https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.md">click here</a> 。</p>
</div>
</div>
<div class="section" id="how-to-write-documentations">
<h2>How to write Documentations<a class="headerlink" href="#how-to-write-documentations" title="Permalink to this headline">¶</a></h2>
<p>PaddlePaddle uses <a class="reference external" href="http://www.sphinx-doc.org/en/1.4.8/">sphinx</a> to compile documentations，Please check sphinx official website for more detail.</p>
</div>
<div class="section" id="how-to-update-www-paddlepaddle-org">
<h2>How to update www.paddlepaddle.org<a class="headerlink" href="#how-to-update-www-paddlepaddle-org" title="Permalink to this headline">¶</a></h2>
<p>Please create PRs and submit them to github, please check <a class="reference external" href="http://www.paddlepaddle.org/docs/develop/documentation/en/howto/dev/contribute_to_paddle_en.html">Contribute Code</a> 。
PaddlePaddle develop branch will update the documentation once the PR is merged. User may check latest <a class="reference external" href="http://www.paddlepaddle.org/docs/develop/documentation/zh/getstarted/index_cn.html">Chinese Docs</a> and
<a class="reference external" href="http://www.paddlepaddle.org/docs/develop/documentation/en/getstarted/index_en.html">English Docs</a> 。</p>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="../faq/index_en.html" class="btn btn-neutral float-right" title="FAQ" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="contribute_to_paddle_en.html" class="btn btn-neutral" title="Contribute Code" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, PaddlePaddle developers.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>