mirror of
https://github.com/pine64/bl_iot_sdk.git
synced 2024-07-19 03:17:21 +00:00
| .. | ||
| README.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>How to add .h files — BL IoT SDK release_bl_iot_sdk_1.6.39-238-gf5ba0a7ee 文档</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
<link rel="author" title="关于这些文档"
href="../about.html"/>
<link rel="index" title="索引"
href="../genindex.html"/>
<link rel="search" title="搜索" href="../search.html"/>
<link rel="top" title="BL IoT SDK release_bl_iot_sdk_1.6.39-238-gf5ba0a7ee 文档" href="../index.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.html" class="icon icon-home"> BL IoT SDK
<img src="../_static/Bouffalolab-logo.png" class="logo" />
</a>
<div class="version">
release_bl_iot_sdk_1.6.39-238-gf5ba0a7ee
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="在文档中搜索" />
<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>
<li class="toctree-l1"><a class="reference internal" href="../get-started/index_602.html">BL602快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../get-started/index_702.html">BL702快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api-reference/index.html">BL602 API 参考</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Examples/index.html">Example</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Components/index.html">Components</a></li>
<li class="toctree-l1"><a class="reference internal" href="../QA/index.html">QA</a></li>
<li class="toctree-l1"><a class="reference internal" href="../hw-reference/index.html">H/W 参考</a></li>
<li class="toctree-l1"><a class="reference internal" href="../resources.html">相关资源</a></li>
<li class="toctree-l1"><a class="reference internal" href="../about.html">关于</a></li>
<li class="toctree-l1"><a class="reference internal" href="../languages.html">Languages/语言</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.html">BL IoT SDK</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 add .h files</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/README/README.rst.txt" rel="nofollow"> 查看页面源码</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-add-h-files">
<h1>How to add .h files<a class="headerlink" href="#how-to-add-h-files" title="永久链接至标题"></a></h1>
<ul class="simple">
<li>for example: we have a head File named <code class="docutils literal notranslate"><span class="pre">example.h</span></code> in
<code class="docutils literal notranslate"><span class="pre">components/sys</span></code> directory,then change to <code class="docutils literal notranslate"><span class="pre">docs</span></code> directory,modify
the <code class="docutils literal notranslate"><span class="pre">INPUT</span></code> configuration in the <code class="docutils literal notranslate"><span class="pre">Doxyfile</span></code> file,here we should
add a line with <code class="docutils literal notranslate"><span class="pre">../../components/sys/example.h</span></code> .</li>
<li>change to <code class="docutils literal notranslate"><span class="pre">docs/zh_CH/API/sys</span></code> subdirectory,new a file named
<code class="docutils literal notranslate"><span class="pre">example.rst</span></code> .</li>
<li>reference <code class="docutils literal notranslate"><span class="pre">docs/zh_CH/API/sys/cronalarms.rst</span></code> ,here we replace
<code class="docutils literal notranslate"><span class="pre">cronalarms</span></code> with <code class="docutils literal notranslate"><span class="pre">example</span></code> .</li>
<li>change to <code class="docutils literal notranslate"><span class="pre">docs/zh_CH</span></code> subdirectory,modify <code class="docutils literal notranslate"><span class="pre">index.rst</span></code> ,add a
line with <code class="docutils literal notranslate"><span class="pre">API/sys/example</span></code> in the last line of the file.</li>
</ul>
</div>
<div class="section" id="building-documentation">
<h1>Building Documentation<a class="headerlink" href="#building-documentation" title="永久链接至标题"></a></h1>
<ul class="simple">
<li>At first,run <code class="docutils literal notranslate"><span class="pre">pip3</span> <span class="pre">install</span> <span class="pre">--user</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code> install
environment</li>
<li>Change to docs/zh_CN subdirectory and run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">html</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">make</span></code> will probably prompt you to run a python pip install step to
get some other Python-related prerequisites. Run the command as
shown, then re-run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">html</span></code> to build the docs.</li>
</ul>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, Bouffalo Lab.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> and ❤️ using a custom <a href="https://github.com/LinxiFan/Stanford-theme">theme</a> based on <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'release_bl_iot_sdk_1.6.39-238-gf5ba0a7ee',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>