Techlord-RCE/espnet
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
<!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>ESPnet document generation — ESPnet 1.0 documentation</title>
<link rel="stylesheet" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fcss%2Ftheme.css" type="text/css" />
<link rel="stylesheet" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fpygments.css" type="text/css" />
<link rel="index" title="Index" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fgenindex.html" />
<link rel="search" title="Search" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fsearch.html" />
<script src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fjs%2Fmodernizr.min.js"></script>
</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="proxy.php?url=https%3A%2F%2Fgithub.com%2Findex.html" class="icon icon-home"> ESPnet
</a>
<div class="version">
1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="proxy.php?url=https%3A%2F%2Fgithub.com%2Fsearch.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">Tutorial:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ftutorial.html">Outline</a></li>
<li class="toctree-l1"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ftutorial.html%23installation">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ftutorial.html%23execution-of-example-scripts">Execution of example scripts</a></li>
<li class="toctree-l1"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ftutorial.html%23installation-using-docker">Installation using Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Ftutorial.html%23references">References</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference Manual:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="proxy.php?url=https%3A%2F%2Fgithub.com%2Fapis%2Fnets.html">espnet nets package</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="proxy.php?url=https%3A%2F%2Fgithub.com%2Findex.html">ESPnet</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="proxy.php?url=https%3A%2F%2Fgithub.com%2Findex.html">Docs</a> »</li>
<li>ESPnet document generation</li>
<li class="wy-breadcrumbs-aside">
<a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F_sources%2FREADME.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="espnet-document-generation">
<span id="espnet-document-generation"></span><h1>ESPnet document generation<a class="headerlink" href="#espnet-document-generation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="install">
<span id="install"></span><h2>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
<p>We use <a class="reference external" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/Syntaf/travis-sphinx">travis-sphinx</a">https://github.com/Syntaf/travis-sphinx">travis-sphinx</a> to generate & deploy HTML documentation.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> <espnet_root>
$ pip install -r doc/requirements.txt
</pre></div>
</div>
</div>
<div class="section" id="generate-html">
<span id="generate-html"></span><h2>Generate HTML<a class="headerlink" href="#generate-html" title="Permalink to this headline">¶</a></h2>
<p>You can generate local HTML manually using sphinx Makefile</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> <espnet_root>/doc
$ make html
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">index.html</span></code> will be created at <code class="docutils literal notranslate"><span class="pre">doc/_build/html/index.html</span></code></p>
<p>or using travis-sphinx</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> <espnet_root>
$ travis-sphinx build --source<span class="o">=</span>doc --nowarn
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">index.html</span></code> will be created at <code class="docutils literal notranslate"><span class="pre">doc/build/index.html</span></code></p>
</div>
<div class="section" id="deploy">
<span id="deploy"></span><h2>Deploy<a class="headerlink" href="#deploy" title="Permalink to this headline">¶</a></h2>
<p>When your PR is merged into <code class="docutils literal notranslate"><span class="pre">master</span></code> branch, our <a class="reference external" href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/espnet/espnet/blob/master/.travis.yml">Travis-CI</a">https://github.com/espnet/espnet/blob/master/.travis.yml">Travis-CI</a> will automatically deploy your sphinx html into https://espnet.github.io/espnet/ by <code class="docutils literal notranslate"><span class="pre">travis-sphinx</span> <span class="pre">deploy</span></code>.</p>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Shinji Watanabe.
</p>
</div>
Built with <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"http://sphinx-doc.org/">Sphinx</a" rel="nofollow">http://sphinx-doc.org/">Sphinx</a> using a <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/rtfd/sphinx_rtd_theme">theme</a">https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://readthedocs.org">Read" rel="nofollow">https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fjquery.js"></script>
<script type="text/javascript" src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Funderscore.js"></script>
<script type="text/javascript" src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fdoctools.js"></script>
<script type="text/javascript" src="proxy.php?url=https%3A%2F%2Fgithub.com%2F_static%2Fjs%2Ftheme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>