252 lines
9.1 KiB
HTML
252 lines
9.1 KiB
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 http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<meta name="author" content="Vector 35 Inc">
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
<title>Contributing Documentation - Binary Ninja User Documentation</title>
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
|
|
<link href="../docs.css?1535411025" rel="stylesheet">
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Contributing Documentation";
|
|
var mkdocs_page_input_path = "dev/documentation.md";
|
|
var mkdocs_page_url = "/dev/documentation.html";
|
|
</script>
|
|
|
|
<script src="../js/jquery-2.1.1.min.js" defer></script>
|
|
<script src="../js/modernizr-2.8.3.min.js" defer></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/cpp.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/python.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
|
|
|
ga('create', 'UA-72420552-3', 'docs.binary.ninja');
|
|
ga('send', 'pageview');
|
|
</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 stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href="../index.html" class="icon icon-home"> Binary Ninja User Documentation</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" title="Type search term here" />
|
|
</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="" href="../index.html">Home</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../getting-started.html">Getting Started Guide</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">User Guide</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../guide/plugins.html">Using and Writing Plugins</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../guide/troubleshooting.html">Troubleshooting</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Developer Guide</span>
|
|
<ul class="subnav">
|
|
<li class=" current">
|
|
|
|
<a class="current" href="documentation.html">Contributing Documentation</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l3"><a href="#building-documentation">Building Documentation</a></li>
|
|
|
|
<ul>
|
|
|
|
<li><a class="toctree-l4" href="#cla">CLA</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#prerequisites">Prerequisites</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#building">Building</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#changing">Changing</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="bnil-llil.html">BNIL Guide: LLIL</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">About</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../about/license.html">License</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../about/open-source.html">Open Source</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</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">Binary Ninja User Documentation</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>Developer Guide »</li>
|
|
|
|
|
|
|
|
<li>Contributing Documentation</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="building-documentation">Building Documentation<a class="headerlink" href="#building-documentation" title="Permanent link">¶</a></h1>
|
|
<h2 id="cla">CLA<a class="headerlink" href="#cla" title="Permanent link">¶</a></h2>
|
|
<p>To contribute to the Binary Ninja documentation, first sign the <a href="https://binary.ninja/cla.pdf">contribution license agreement</a> and send it to <a href="https://vector35.com/">Vector 35</a>.</p>
|
|
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">¶</a></h2>
|
|
<ul>
|
|
<li><a href="http://www.sphinx-doc.org/en/stable/index.html">sphinx</a></li>
|
|
<li><a href="https://github.com/michaeljones/breathe">breathe</a> (note that on windows, breathe needs a small <a href="https://github.com/michaeljones/breathe/issues/271">fix</a>)</li>
|
|
<li><a href="http://www.mkdocs.org/">mkdocs</a></li>
|
|
<li><a href="http://www.stack.nl/~dimitri/doxygen/">doxygen</a></li>
|
|
</ul>
|
|
<h2 id="building">Building<a class="headerlink" href="#building" title="Permanent link">¶</a></h2>
|
|
<div class="codehilite"><pre><span></span>git clone https://github.com/Vector35/binaryninja-api/
|
|
cd binaryninja-api
|
|
cd api
|
|
mkdocs build
|
|
echo User documentation available in site/
|
|
cd api-docs
|
|
make html
|
|
echo API documentation available in build/html
|
|
</pre></div>
|
|
|
|
|
|
<h2 id="changing">Changing<a class="headerlink" href="#changing" title="Permanent link">¶</a></h2>
|
|
<p>Changing documentation for the API itself is fairly straight forward. Use <a href="https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html">doxygen style comment blocks</a> in C++ and C, and <a href="http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html">restructured text blocks</a> for python for the source. The user documentation is located in the <code>api/docs/</code> folder and the API documentation is generated from the config in the <code>api/api-docs</code> folder.</p>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Tip</p>
|
|
<p>When updating user documentation, the <code>mkdocs serve</code> feature is particularly helpful.</p>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="bnil-llil.html" class="btn btn-neutral float-right" title="BNIL Guide: LLIL">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../guide/troubleshooting.html" class="btn btn-neutral" title="Troubleshooting"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
<p>(<a href="https://creativecommons.org/licenses/by/3.0/">cc</a>) Vector 35 Inc</p>
|
|
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</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>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
|
|
<span><a href="../guide/troubleshooting.html" style="color: #fcfcfc;">« Previous</a></span>
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="bnil-llil.html" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
|
|
</body>
|
|
</html>
|